Class ExcelExportProperties

Defines the options for customizing the excel document during export.

Inheritance
System.Object
ExcelExportProperties
TreeGridExcelExportProperties
Implements
System.IEquatable<ExcelExportProperties>
Namespace: Syncfusion.Blazor.Grids
Assembly: Syncfusion.Blazor.dll
Syntax
public class ExcelExportProperties : Object, IEquatable<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 Description
System.Collections.Generic.List<GridColumn>

DataSource

Defines the data source dynamically before exporting

Declaration
public IEnumerable<object> DataSource { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.Object>

ExportType

Indicates to export current page or all page

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

FileName

Defines the file name for the exported file

Declaration
public string FileName { get; set; }
Property Value
Type Description
System.String

Defines the footer content for exported document

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

GridSheetIndex

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

Declaration
public int GridSheetIndex { get; set; }
Property Value
Type Description
System.Int32

Header

Defines the header content for exported document

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

HierarchyExportMode

Defines the hierarchy export mode for the pdf grid

Declaration
public HierarchyExportMode HierarchyExportMode { get; set; }
Property Value
Type Description
Syncfusion.Blazor.Grids.HierarchyExportMode

IncludeCommandColumn

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

Declaration
public bool IncludeCommandColumn { get; set; }
Property Value
Type Description
System.Boolean

IncludeHeaderRow

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

Declaration
public bool IncludeHeaderRow { get; set; }
Property Value
Type Description
System.Boolean

IncludeHiddenColumn

Indicates whether to show the hidden columns in exported excel

Declaration
public bool IncludeHiddenColumn { get; set; }
Property Value
Type Description
System.Boolean

IncludeTemplateColumn

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

Declaration
public bool IncludeTemplateColumn { get; set; }
Property Value
Type Description
System.Boolean

MultipleExport

Exports multiple grid into the excel document

Declaration
public MultipleExport MultipleExport { get; set; }
Property Value
Type Description
MultipleExport

Theme

Defines the theme for exported data

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

Workbook

Defines the additional workbook sheets for export

Declaration
public Workbook Workbook { get; set; }
Property Value
Type Description
Syncfusion.ExcelExport.Workbook

Methods

Equals(ExcelExportProperties)

Declaration
public bool Equals(ExcelExportProperties excelExportProperties)
Parameters
Type Name Description
ExcelExportProperties excelExportProperties
Returns
Type Description
System.Boolean

Implements

System.IEquatable<>