Class DataGridExcelExportingOption

Represents a class which is used to set the exporting options for the excel. User can pass this class as an argument to the ExportToExcel(SfDataGrid, DataGridExcelExportingOption) for customizing data exported to the excel.

Inheritance

System.Object

DataGridExcelExportingOption

Namespace: Syncfusion.Maui.DataGrid.Exporting

Assembly: Syncfusion.Maui.DataGridExport.dll

Syntax

public class DataGridExcelExportingOption : Object

Constructors

DataGridExcelExportingOption()

Initializes a new instance of the DataGridExcelExportingOption class.

Declaration

public DataGridExcelExportingOption()

Properties

BottomTableSummaryStyle

Gets or sets the style to be applied for the exporting bottom table summaries in the grid.

Declaration

public DataGridExportCellStyle BottomTableSummaryStyle { get; set; }

Property Value

Type
DataGridExportCellStyle

CanAllowOutlining

Gets or sets a value indicating whether the groups in the SfdataGrid should export with expand/collapse options or not.

Declaration

public bool CanAllowOutlining { get; set; }

Property Value

Type
System.Boolean

CanAllowSortingAndFiltering

Gets or sets a value indicating whether it is needed to apply excel filtering and sorting for the exported file.

Declaration

public bool CanAllowSortingAndFiltering { get; set; }

Property Value

Type
System.Boolean

CanApplyGridStyle

Gets or sets a value indicating whether the grid style of the SfdataGrid need to be exported or not.

Declaration

public bool CanApplyGridStyle { get; set; }

Property Value

Type
System.Boolean

CanExportAllPages

Gets or sets a value indicating whether all the pages in DataPager should be exported or not.

Declaration

public bool CanExportAllPages { get; set; }

Property Value

Type
System.Boolean

CanExportColumnWidth

Gets or sets a value indicating whether the column widths can be exported or not, if not default column width will be assigned.

Declaration

public bool CanExportColumnWidth { get; set; }

Property Value

Type
System.Boolean

CanExportGroups

Gets or sets a value indicating whether the groups in the SfdataGrid is to be exported or not.

Declaration

public bool CanExportGroups { get; set; }

Property Value

Type
System.Boolean

CanExportGroupSummary

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

Declaration

public bool CanExportGroupSummary { get; set; }

Property Value

Type
System.Boolean

CanExportHeader

Gets or sets a value indicating whether the header is to be exported or not.

Declaration

public bool CanExportHeader { get; set; }

Property Value

Type
System.Boolean

CanExportRowHeight

Gets or sets a value indicating whether the row heights can be exported or not, if not default row height will be assigned

Declaration

public bool CanExportRowHeight { get; set; }

Property Value

Type
System.Boolean

CanExportStackedHeaders

Gets or sets a value indicating whether the is to be exported or not.

Declaration

public bool CanExportStackedHeaders { get; set; }

Property Value

Type
System.Boolean

CanExportTableSummary

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

Declaration

public bool CanExportTableSummary { get; set; }

Property Value

Type
System.Boolean

CanExportUnboundRows

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

Declaration

public bool CanExportUnboundRows { get; set; }

Property Value

Type
System.Boolean

Columns

Gets or internal sets the columns collection containing all the columns in the SfdataGrid excluding the columns in the ExcludedColumns list.

Declaration

public IEnumerable<DataGridColumn> Columns { get; }

Property Value

Type
System.Collections.Generic.IEnumerable<DataGridColumn>

DefaultColumnWidth

Gets or sets the default column width for exporting. The default column width will be applied for exporting when ExportColumnWidth is false.

Declaration

public int DefaultColumnWidth { get; set; }

Property Value

Type
System.Int32

DefaultRowHeight

Gets or sets the default row height for exporting. The default row height will be applied for exporting when ExportRowHeight is false.

Declaration

public int DefaultRowHeight { get; set; }

Property Value

Type
System.Int32

ExcelColumnIndex

Gets or internal sets the index of the column being exported to the excel. Each column is exported based on this index, which enable to identify current exporting column index

Declaration

public int ExcelColumnIndex { get; }

Property Value

Type
System.Int32

ExcelRowIndex

Gets the index of the row being exported to the excel. Each row is exported based on this index, which enable to identify current exporting row index.

Declaration

public int ExcelRowIndex { get; }

Property Value

Type
System.Int32

ExcelVersion

Gets or sets the excel version for exporting the data to the excel. The user can customize the exporting workbook version by using this property.

Declaration

public ExcelVersion ExcelVersion { get; set; }

Property Value

Type
ExcelVersion

ExcludedColumns

Gets or sets the list of columns that to be excluded from exporting.

Declaration

public List<string> ExcludedColumns { get; set; }

Property Value

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

ExportMode

Gets or sets the export mode specifying whether the data in the grid should exported as value or text.

Declaration

public ExportMode ExportMode { get; set; }

Property Value

Type
ExportMode

GroupCaptionStyle

Gets or sets the style to be applied for the exporting group caption summaries in the grid

Declaration

public DataGridExportCellStyle GroupCaptionStyle { get; set; }

Property Value

Type
DataGridExportCellStyle

GroupSummaryStyle

Gets or sets the style to be applied for the exporting group summaries in the grid.

Declaration

public DataGridExportCellStyle GroupSummaryStyle { get; set; }

Property Value

Type
DataGridExportCellStyle

HeaderStyle

Gets or sets the style to be applied for the exporting header in the grid.

Declaration

public DataGridExportCellStyle HeaderStyle { get; set; }

Property Value

Type
DataGridExportCellStyle

RecordStyle

Gets or sets the style to be applied for the exporting record in the grid.

Declaration

public DataGridExportCellStyle RecordStyle { get; set; }

Property Value

Type
DataGridExportCellStyle

Sheet

Gets the excel sheet for exporting the data in the grid.

Declaration

public IWorksheet Sheet { get; }

Property Value

Type
IWorksheet

StackedHeaderStyle

Gets or sets the style to be applied for the exporting in the grid.

Declaration

public DataGridExportCellStyle StackedHeaderStyle { get; set; }

Property Value

Type
DataGridExportCellStyle

StartColumnIndex

Gets or sets the starting column index of the excel from which the data in the grid is to be exported.

Declaration

public int StartColumnIndex { get; set; }

Property Value

Type
System.Int32

StartRowIndex

Gets or sets the starting row index of the excel from which the data in the grid is to be exported.

Declaration

public int StartRowIndex { get; set; }

Property Value

Type
System.Int32

TopTableSummaryStyle

Gets or sets the style to be applied for the exporting top table summaries in the grid.

Declaration

public DataGridExportCellStyle TopTableSummaryStyle { get; set; }

Property Value

Type
DataGridExportCellStyle

UnboundRowStyle

Gets or sets the style to be applied for the exporting in the grid.

Declaration

public DataGridExportCellStyle UnboundRowStyle { get; set; }

Property Value

Type
DataGridExportCellStyle