Class ExcelExportProperties

Defines the options for customizing the excel document during export.

Inheritance
object
ExcelExportProperties
TreeGridExcelExportProperties
Inherited Members
Namespace: Syncfusion.Blazor.Grids
Assembly: Syncfusion.Blazor.dll
Syntax
public class ExcelExportProperties

Constructors

ExcelExportProperties()

Declaration
public ExcelExportProperties()

Properties

Columns

Defines the columns which are to be customized for Export alone.

Declaration
public List<GridColumn> Columns { get; set; }
Property Value
Type
List<GridColumn>

DataSource

Defines the data source dynamically before exporting.

Declaration
public IEnumerable<object> DataSource { get; set; }
Property Value
Type
IEnumerable<object>

ExcelDetailRowMode

Gets or sets the mode for exporting detail rows to excel file format.

Declaration
public ExcelDetailRowMode ExcelDetailRowMode { get; set; }
Property Value
Type
ExcelDetailRowMode
Remarks

This property determines how detail rows are exported in Excel exporting.

  • When set to "Expand", detail rows are exported in their expanded state.
  • When set to “Collapse” details rows are exported in their collapsed state.
  • When set to "None", only parent rows are exported. The default mode is Expand.

ExportType

Indicates to export current page or all page.

Declaration
public ExportType ExportType { get; set; }
Property Value
Type
ExportType

FileName

Defines the file name for the exported file.

Declaration
public string FileName { get; set; }
Property Value
Type
string

Defines the footer content for exported document.

Declaration
public ExcelFooter Footer { get; set; }
Property Value
Type
ExcelFooter

GridSheetIndex

Defines the Grid sheet index. Based on index Grid sheet will append.

Declaration
public int GridSheetIndex { get; set; }
Property Value
Type
int

Header

Defines the header content for exported document.

Declaration
public ExcelHeader Header { get; set; }
Property Value
Type
ExcelHeader

HierarchyExportMode

Defines the hierarchy export mode for the pdf grid.

Declaration
public HierarchyExportMode HierarchyExportMode { get; set; }
Property Value
Type
HierarchyExportMode

IncludeCommandColumn

Indicates whether to show/hide the command columns in exported excel.

Declaration
public bool IncludeCommandColumn { get; set; }
Property Value
Type
bool

IncludeHeaderRow

Enable/disable the property to export the Grid column header row.

Declaration
public bool IncludeHeaderRow { get; set; }
Property Value
Type
bool

IncludeHiddenColumn

Indicates whether to show the hidden columns in exported excel.

Declaration
public bool IncludeHiddenColumn { get; set; }
Property Value
Type
bool

IncludeTemplateColumn

Indicates whether to show/hide the Template columns in exported excel.

Declaration
public bool IncludeTemplateColumn { get; set; }
Property Value
Type
bool

Theme

Defines the theme for exported data.

Declaration
public ExcelTheme Theme { get; set; }
Property Value
Type
ExcelTheme

Workbook

Defines the additional workbook sheets for export.

Declaration
public Workbook Workbook { get; set; }
Property Value
Type
Workbook