ClassExportToExcelML
Definition
Namespace:Telerik.WinControls.UI.Export
Assembly:TelerikData.dll
Syntax:
public class ExportToExcelML : IExportGridToInheritance: objectExportToExcelML
Implements:
Constructors
ExportToExcelML(RadGridView)
Declaration
public ExportToExcelML(RadGridView radGridView)Parameters
radGridView
Properties
ChildViewExportMode
Gets or sets the child view export mode.
Declaration
public ChildViewExportMode ChildViewExportMode { get; set; }Property Value
The child view export mode.
Encoding
Gets or sets the encoding used for the exported file. Default encoding is UTF8.
ExportHierarchy
Set if child rows should be exported.
ExportVisualSettings
Sets a value indicating whether the visual settings should be exported.
Declaration
public bool ExportVisualSettings { set; }Property Value
true if visual settings are exported; otherwise, false.
FileExtension
Sets the file extension of the exported file.
Declaration
public string FileExtension { set; }Property Value
The file extension.
Implements
HiddenColumnOption
Sets a value indicating how hidden columns are exported.
Declaration
public HiddenOption HiddenColumnOption { set; }Property Value
The hidden column option.
Implements
HiddenRowOption
Sets a value indicating how hidden rows are exported.
Declaration
public HiddenOption HiddenRowOption { set; }Property Value
The hidden row option.
Implements
PagingExportOption
Sets a value indicating how the export behavies when paging is enabled.
Declaration
public PagingExportOption PagingExportOption { set; }Property Value
The paging export option.
RadGridViewToExport
Sets the RadGridView to export.
Declaration
public RadGridView RadGridViewToExport { set; }Property Value
The RadGridView to export.
Implements
SheetMaxRows
Sets the sheet max rows.
Declaration
public ExcelMaxRows SheetMaxRows { set; }Property Value
The sheet max rows.
SheetName
Sets the name of the sheet.
Declaration
public string SheetName { set; }Property Value
The name of the sheet.
SummariesExportOption
Sets a value indicating how summary rows are exported.
Declaration
public SummariesOption SummariesExportOption { set; }Property Value
The summaries export option.
Implements
Methods
AddCustomExcelRow(TableElement, int, params object[])
Add custom row in the provided excel table element
Declaration
public SingleStyleElement AddCustomExcelRow(TableElement excelTableElement, int rowHeight, params object[] cellValues)Parameters
excelTableElement
Excel table element where the new row will be added
rowHeight
Custom row height in pixels. If 0 than the height has default value
cellValues
object[]
Values for the every excel cell in the custom row
Returns
New row's style element for further formatting
OnChildViewExporting(ChildViewExportingEventArgs)
Raises the event.
Declaration
protected virtual void OnChildViewExporting(ChildViewExportingEventArgs e)Parameters
e
The ChildViewExportingEventArgs instance containing the event data.
OnExcelCellFormatting(ExcelCellFormattingEventArgs)
Raises the event.
Declaration
protected virtual void OnExcelCellFormatting(ExcelCellFormattingEventArgs e)Parameters
e
The ExcelCellFormattingEventArgs instance containing the event data.
OnExcelCellFormatting(ExcelRowFormattingEventArgs)
Raises the event.
Declaration
protected virtual void OnExcelCellFormatting(ExcelRowFormattingEventArgs e)Parameters
e
The ExcelRowFormattingEventArgs instance containing the event data.
OnExcelTableCreated(ExcelTableCreatedEventArgs)
Raises the event.
Declaration
protected virtual void OnExcelTableCreated(ExcelTableCreatedEventArgs e)Parameters
e
The ExcelTableCreatedEventArgs instance containing the event data.
RunExport(string)
Creates ExcelML file
Declaration
public void RunExport(string fileName)Parameters
fileName
Export file name
Implements
Events
ChildViewExporting
Occurs when a child view will be exported.
Declaration
public event ChildViewExportingEventHandler ChildViewExportingEvent Value
ExcelCellFormatting
Occurs for every cell that is being exported.
Declaration
public event ExcelCellFormattingEventHandler ExcelCellFormattingEvent Value
ExcelRowFormatting
Occurs for every row that is being exported.
Declaration
public event ExcelRowFormattingEventHandler ExcelRowFormattingEvent Value
ExcelTableCreated
Occurs when the excel table is created.
Declaration
public event ExcelTableCreatedEventHandler ExcelTableCreatedEvent Value