Documentation

Class ExportToExcelML

Inheritance
System.Object
ExportToExcelML
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI.Export
Assembly: TelerikData.dll

Syntax

public class ExportToExcelML : IExportGridTo

Constructors

ExportToExcelML(RadGridView)

Declaration
public ExportToExcelML(RadGridView radGridView)
Parameters
RadGridView radGridView

Properties

ChildViewExportMode

Gets or sets the child view export mode.

Declaration
public ChildViewExportMode ChildViewExportMode { get; set; }
Property Value
ChildViewExportMode

The child view export mode.

Encoding

Gets or sets the encoding used for the exported file. Default encoding is UTF8.

Declaration
public Encoding Encoding { get; set; }
Property Value
System.Text.Encoding

ExportHierarchy

Set if child rows should be exported.

Declaration
public bool ExportHierarchy { set; }
Property Value
System.Boolean

ExportVisualSettings

Sets a value indicating whether the visual settings should be exported.

Declaration
public bool ExportVisualSettings { set; }
Property Value
System.Boolean

true if visual settings are exported; otherwise, false.

FileExtension

Sets the file extension of the exported file.

Declaration
public string FileExtension { set; }
Property Value
System.String

The file extension.
Implements

HiddenColumnOption

Sets a value indicating how hidden columns are exported.

Declaration
public HiddenOption HiddenColumnOption { set; }
Property Value
HiddenOption

The hidden column option.
Implements

HiddenRowOption

Sets a value indicating how hidden rows are exported.

Declaration
public HiddenOption HiddenRowOption { set; }
Property Value
HiddenOption

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
PagingExportOption

The paging export option.

RadGridViewToExport

Sets the RadGridView to export.

Declaration
public RadGridView RadGridViewToExport { set; }
Property Value
RadGridView

The RadGridView to export.
Implements

SheetMaxRows

Sets the sheet max rows.

Declaration
public ExcelMaxRows SheetMaxRows { set; }
Property Value
ExcelMaxRows

The sheet max rows.

SheetName

Sets the name of the sheet.

Declaration
public string SheetName { set; }
Property Value
System.String

The name of the sheet.

SummariesExportOption

Sets a value indicating how summary rows are exported.

Declaration
public SummariesOption SummariesExportOption { set; }
Property Value
SummariesOption

The summaries export option.
Implements

Methods

AddCustomExcelRow(TableElement, Int32, Object[])

Add custom row in the provided excel table element

Declaration
public SingleStyleElement AddCustomExcelRow(TableElement excelTableElement, int rowHeight, params object[] cellValues)
Parameters
TableElement excelTableElement

Excel table element where the new row will be added
System.Int32 rowHeight

Custom row height in pixels. If 0 than the height has default value
System.Object[] cellValues

Values for the every excel cell in the custom row
Returns
SingleStyleElement

New row's style element for further formatting

OnChildViewExporting(ChildViewExportingEventArgs)

Raises the ChildViewExporting event.

Declaration
protected virtual void OnChildViewExporting(ChildViewExportingEventArgs e)
Parameters
ChildViewExportingEventArgs e

The ChildViewExportingEventArgs instance containing the event data.

OnExcelCellFormatting(ExcelCellFormattingEventArgs)

Raises the ExcelCellFormatting event.

Declaration
protected virtual void OnExcelCellFormatting(ExcelCellFormattingEventArgs e)
Parameters
ExcelCellFormattingEventArgs e

The ExcelCellFormattingEventArgs instance containing the event data.

OnExcelCellFormatting(ExcelRowFormattingEventArgs)

Raises the ExcelCellFormatting event.

Declaration
protected virtual void OnExcelCellFormatting(ExcelRowFormattingEventArgs e)
Parameters
ExcelRowFormattingEventArgs e

The ExcelRowFormattingEventArgs instance containing the event data.

OnExcelTableCreated(ExcelTableCreatedEventArgs)

Raises the ExcelTableCreated event.

Declaration
protected virtual void OnExcelTableCreated(ExcelTableCreatedEventArgs e)
Parameters
ExcelTableCreatedEventArgs e

The ExcelTableCreatedEventArgs instance containing the event data.

RunExport(String)

Creates ExcelML file

Declaration
public void RunExport(string fileName)
Parameters
System.String fileName

Export file name
Implements

Events

ChildViewExporting

Occurs when a child view will be exported.

Declaration
public event ChildViewExportingEventHandler ChildViewExporting
Event Type
ChildViewExportingEventHandler

ExcelCellFormatting

Occurs for every cell that is being exported.

Declaration
public event ExcelCellFormattingEventHandler ExcelCellFormatting
Event Type
ExcelCellFormattingEventHandler

ExcelRowFormatting

Occurs for every row that is being exported.

Declaration
public event ExcelRowFormattingEventHandler ExcelRowFormatting
Event Type
ExcelRowFormattingEventHandler

ExcelTableCreated

Occurs when the excel table is created.

Declaration
public event ExcelTableCreatedEventHandler ExcelTableCreated
Event Type
ExcelTableCreatedEventHandler

Extension Methods