Class ExcelExportingOptions

Class which is used to set the exporting options. User can pass the instance of this class as an argument to the ExportToExcel method.

Inheritance

System.Object

ExcelExportingOptions

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.WinForms.DataGridConverter

Assembly: Syncfusion.SfDataGridConverter.WinForms.dll

Syntax

public class ExcelExportingOptions

Constructors

ExcelExportingOptions()

Initializes a new instance of the ExcelExportingOptions class.

Declaration

public ExcelExportingOptions()

Fields

ExcludeColumns

list of columns that should be excluded while exporting

Declaration

public List<string> ExcludeColumns

Field Value

Type
System.Collections.Generic.List<System.String>

Properties

AllowOutlining

Gets or sets the value that indicates whether the groups should export with expand/collapse options or not. There is no indent space maintained if AllowOutlining is set to true. If the grid contains the Details View definition, the AllowOutlining is set to true internally.

Declaration

public bool AllowOutlining { get; set; }

Property Value

Type	Description
System.Boolean	true if Outlining is enabled; otherwise, false.The default value is true.

Columns

Gets list of columns which includes excluding of ExcludeColumns.

Declaration

public List<string> Columns { get; }

Property Value

Type
System.Collections.Generic.List<System.String>

DefaultColumnWidth

Gets or sets the default column width in Excel sheet for all columns. This is applicable when disabling ExportColumnWidth.

Declaration

public int DefaultColumnWidth { get; set; }

Property Value

Type
System.Int32

DefaultRowHeight

Gets or sets the default row height in Excel sheet for all rows. This is applicable when disabling ExportRowHeight.

Declaration

public int DefaultRowHeight { get; set; }

Property Value

Type
System.Int32

ExcelVersion

Gets or sets the Excel version for the exported workbook.

Declaration

public ExcelVersion ExcelVersion { get; set; }

Property Value

Type	Description
ExcelVersion	One of the ExcelVersion enumeration values that specifies the Excel version. The default value is Excel2007.

ExportAllPages

Gets or sets the value which specifies whether all pages should be exported for PagedCollection.By default, only current page will be exported

Declaration

public bool ExportAllPages { get; set; }

Property Value

Type	Description
System.Boolean	true if all pages should be exported; otherwise, false.The default value is false.

Remarks

This option is not supported with OnDemandPaging.

ExportBorders

Gets or sets a value indicating whether borders should be exported or not. This is applicable when enabling ExportStyle.

Declaration

public bool ExportBorders { get; set; }

Property Value

Type	Description
System.Boolean	true if border should be exported; otherwise, false.The default value is false.

ExportColumnWidth

Gets or sets a value indicating whether columns width is should be exported or not.

Declaration

public bool ExportColumnWidth { get; set; }

Property Value

Type	Description
System.Boolean	true if column width should be exported; otherwise, false.The default value is false.

ExportFreezePanes

Declaration

public bool ExportFreezePanes { get; set; }

Property Value

Type
System.Boolean

ExportGroupSummary

Gets or sets a value indicating whether group summary should be exported or not.

Declaration

public bool ExportGroupSummary { get; set; }

Property Value

Type	Description
System.Boolean	true if GroupSummary should be exported; otherwise, false.The default value is true.

ExportMergedCells

Gets or Sets the value which indicates whether the Merged Cells should be exported or not

Declaration

public bool ExportMergedCells { get; set; }

Property Value

Type	Description
System.Boolean	true if MergedCells should be exported; otherwise, false.The default value is false.

ExportMode

Gets or sets the value which specifies how the data should be exported to Excel

Declaration

public ExportMode ExportMode { get; set; }

Property Value

Type	Description
ExportMode	One of the enumeration that specifies the ExportMode. The default mode is .

ExportPageOptions

Gets or sets the value which specifies how paged collection should be exported to excel

Declaration

public ExportPageOptions ExportPageOptions { get; set; }

Property Value

Type	Description
ExportPageOptions	One of the enumeration that specifies the ExportPageOptions. The default mode is .

ExportRowHeight

Gets or sets a value indicating whether row height should be exported or not.

Declaration

public bool ExportRowHeight { get; set; }

Property Value

Type	Description
System.Boolean	true if row height should be exported; otherwise, false.The default value is false.

ExportStackedHeaders

Gets or sets the value which indicates whether stacked headers should be exported or not

Declaration

public bool ExportStackedHeaders { get; set; }

Property Value

Type	Description
System.Boolean	true if StackedHeaders should be exported; otherwise, false.The default value is false.

ExportStyle

Declaration

public bool ExportStyle { get; set; }

Property Value

Type
System.Boolean

ExportTableSummary

Gets or sets a value indicating whether table summary should be exported or not.

Declaration

public bool ExportTableSummary { get; set; }

Property Value

Type	Description
System.Boolean	true if TableSummary should be exported; otherwise, false.The default value is true.

ExportUnboundRows

Gets or sets the value which indicates whether the UnBoundRows should be exported or not

Declaration

public bool ExportUnboundRows { get; set; }

Property Value

Type	Description
System.Boolean	true if UnBoundRows should be exported; otherwise, false.The default value is false.

RowIndex

Gets or sets the row index of SfDataGrid which keeps track of the row index while exporting.

Declaration

public int RowIndex { get; set; }

Property Value

Type
System.Int32

StartColumnIndex

Gets or sets the starting column index for the exported data in the Excel sheet.

Declaration

public int StartColumnIndex { get; set; }

Property Value

Type
System.Int32

StartRowIndex

Gets or sets the starting row index for the exported data in the Excel sheet.

Declaration

public int StartRowIndex { get; set; }

Property Value

Type
System.Int32

Events

CellExporting

Occurs while exporting the each cell into Excel.

Declaration

public event DataGridCellExcelExportingEventHandler CellExporting

Event Type

Type
DataGridCellExcelExportingEventHandler

ChildExporting

Occurs while exporting the details view child cell into Excel.

Declaration

public event DataGridChildExportingEventHandler ChildExporting

Event Type

Type
DataGridChildExportingEventHandler

Exporting

Occurs only once while exporting the each cell type into Excel.

Declaration

public event DataGridExcelExportingEventHandler Exporting

Event Type

Type
DataGridExcelExportingEventHandler