Class ExcelExportProperties

Defines the options for customizing the Excel document during export.

Inheritance

System.Object

ExcelExportProperties

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.EJ2.TreeGridExport

Assembly: Syncfusion.EJ2.GridExport.dll

Syntax

public class ExcelExportProperties

Remarks

This class provides properties that allow customization of the Excel document's export behavior and appearance. It includes options for specifying the export type (current page or all pages), the file name for the exported file, whether to include hidden columns in the exported Excel, and the separator for CSV file export.

Constructors

ExcelExportProperties()

Declaration

public ExcelExportProperties()

Properties

ExportType

Gets or sets a value indicating whether all pages or the current page should be exported.

Declaration

public ExportType ExportType { get; set; }

Property Value

Type	Description
ExportType	One of the ExportType enumeration that specifies which portion of the content is exported. The default mode is AllPages.

Remarks

Use this property to control which portion of the content should be exported. When set to AllPages, the entire content, including all pages, will be exported. When set to CurrentPage, only the content of the current page will be exported.

FileName

Gets or sets the file name for the exported Excel file.

Declaration

public string FileName { get; set; }

Property Value

Type	Description
System.String	A string representing the name of the Excel file to be exported.

IncludeHiddenColumn

Gets or sets a value indicating whether hidden columns should be included in the exported Excel document.

Declaration

public bool IncludeHiddenColumn { get; set; }

Property Value

Type	Description
System.Boolean	true if hidden columns should be included in the export; otherwise, false.

Remarks

Hidden columns are typically excluded from the export to simplify the exported content, but you may want to include them if the hidden columns contain important information for the exported content.