Class TreeGridExportBase

Represents a base class for exporting.

Inheritance

System.Object

TreeGridExportBase

TreeGridExcelExport

TreeGridPdfExport

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 TreeGridExportBase

Remarks

This class provides the fundamental properties for exporting data to Excel, PDF, and CSV formats. It includes essential properties that define common export settings and behaviors, making it easier to create specialized exporting functionalities.

Constructors

TreeGridExportBase()

Declaration

public TreeGridExportBase()

Properties

DataSource

Gets or sets the datasource collection of tree grid to be exported.

Declaration

public IEnumerable DataSource { get; set; }

Property Value

Type	Description
System.Collections.IEnumerable	An instance of System.Collections.IEnumerable datasource.

EmptyText

Gets or sets the text to display when exporting an empty record.

Declaration

public string EmptyText { get; set; }

Property Value

Type	Description
System.String	The text to display for an empty record.

FileName

Gets or sets the name of the file to be exported.

Declaration

public string FileName { get; set; }

Property Value

Type	Description
System.String	The name of the file.

FilePath

Gets or sets the file path for saving the exported file locally.

Declaration

public string FilePath { get; set; }

Property Value

Type	Description
System.String	The file path for saving the file in local storage.

FontWeight

Gets or sets a value that decides the thickness of font characters in the exported document.

Declaration

public FontWeight FontWeight { get; set; }

Property Value

Type	Description
FontWeight	One of the FontWeight enumeration that specifies how the text thickness in the exported document. The default value is .

Remarks

The Syncfusion.EJ2.GridExport.FontWeight enumeration determines the thickness of the characters in the exported document. This property is useful when you want to control the visual appearance of the text content in the exported document.

FormatOptions

Gets or sets an instance of settings to exported content. It allows you to control the appearance and layout of the exported data, including colors, fonts, and alignment.

Declaration

public AutoFormat FormatOptions { get; set; }

Property Value

Type	Description
AutoFormat	An instance of .

HeaderText

Gets or sets the header text to be used for multiple export.

Declaration

public string HeaderText { get; set; }

Property Value

Type	Description
System.String	The header text that will be displayed for multiple exports.

IncludeHiddenColumns

Gets or sets the value indicating whether the hidden column is included in the exported content of the tree grid.

Declaration

public bool IncludeHiddenColumns { get; set; }

Property Value

Type	Description
System.Boolean	true if the hidden columns are included in the exporting content; otherwise, false. The default value is false.

Remarks

This property provides flexibility on show or hide columns in exported content.