Class TreeGridExcelExportingOptions

Represent a class that provides various properties and event handlers to customize SfTreeGrid to Excel exporting.

Inheritance

System.Object

TreeGridExcelExportingOptions

Namespace: Syncfusion.UI.Xaml.TreeGrid.Converter

Assembly: Syncfusion.SfGridConverter.WPF.dll

Syntax

public class TreeGridExcelExportingOptions : Object

Constructors

TreeGridExcelExportingOptions()

Declaration

public TreeGridExcelExportingOptions()

Fields

ExcludeColumns

list of columns that should be excluded while exporting

Declaration

public List<string> ExcludeColumns

Field Value

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

Properties

AllowIndentColumn

Gets or sets the value that indicates whether the nodes should export with indent to denote it level.

Declaration

public bool AllowIndentColumn { get; set; }

Property Value

Type	Description
System.Boolean	true if the user can add the indent column based on the node level; otherwise, false. The default value is false.

AllowOutliningGroups

Gets or sets the value that indicates whether the nodes should export with outlines or groups to denote the its level.

Declaration

public bool AllowOutliningGroups { get; set; }

Property Value

Type	Description
System.Boolean	true if the user can group the record based on the node level; Otherwisefalse. The default value is true.

CanExportHyperLink

Gets or sets a value which indicates whether hyperlink column should be export with link or not.

Declaration

public bool CanExportHyperLink { get; set; }

Property Value

Type
System.Boolean

CellsExportingEventHandler

Gets or sets the value which is used to handle or customize the exporting of a particular cell in Excel.

Declaration

public TreeGridCellExcelExportingEventHandler CellsExportingEventHandler { get; set; }

Property Value

Type
TreeGridCellExcelExportingEventHandler

Columns

Gets list of columns to export by excluding of ExcludeColumns.

Declaration

public List<string> Columns { get; }

Property Value

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

DefaultColumnWidth

Gets or sets the default column width for the exported Excel sheet.

Declaration

public double DefaultColumnWidth { get; set; }

Property Value

Type
System.Double

DefaultRowHeight

Gets or sets the default row height for the exported Excel sheet.

Declaration

public double DefaultRowHeight { get; set; }

Property Value

Type
System.Double

ExcelStartColumnIndex

Gets or sets the value which specifies start column index in Excel.

Declaration

public int ExcelStartColumnIndex { get; set; }

Property Value

Type
System.Int32

ExcelStartRowIndex

Gets or sets the value which specifies start row index in Excel.

Declaration

public int ExcelStartRowIndex { get; set; }

Property Value

Type
System.Int32

ExcelVersion

Gets or sets the Excel version for the exported workbook.

Declaration

public ExcelVersion ExcelVersion { get; set; }

Property Value

Type	Description
ExcelVersion	One of the ExcelVersion enumeration values that specifies the Excel version. The default value is Excel2010.

ExportColumnWidth

Gets or sets the value that indicates whether the export with treeGridColumnWidth or defaultColumnWidth.

Declaration

public bool ExportColumnWidth { get; set; }

Property Value

Type	Description
System.Boolean	true if the user can set the treegrid column width to excel sheet; otherwise,false the default width is set to the excel sheet. The default value is true.

ExportingEventHandler

Gets or sets the value which is used to customize the styles for Header rows and Record rows.

Declaration

public TreeGridExcelExportingEventHandler ExportingEventHandler { get; set; }

Property Value

Type
TreeGridExcelExportingEventHandler

ExportStackedHeaders

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

Declaration

public bool ExportStackedHeaders { get; set; }

Property Value

Type	Description
System.Boolean	true if StackedHeaders should be exported; otherwise, false.The default value is false.

IsGridLinesVisible

Gets or sets the value that indicates whether the export with grid line in worksheet or not.

Declaration

public bool IsGridLinesVisible { get; set; }

Property Value

Type	Description
System.Boolean	true if the user can set the grid lines visible to excel sheet; otherwise,false the default width is set to the excel sheet. The default value is true.

NodeExpandMode

Gets or sets the value which specifies how the data should be exported to Excel

Declaration

public NodeExpandMode NodeExpandMode { get; set; }

Property Value

Type	Description
NodeExpandMode	One of the NodeExpandMode enumeration that specifies the NodeExpandMode. The default mode is ExpandAll.

TreeGridExportMode

Gets or sets the value which specifies how the data should be exported to excel

Declaration

public TreeGridExportMode TreeGridExportMode { get; set; }

Property Value

Type	Description
TreeGridExportMode	One of the enumeration that specifies the ExportMode. The default mode is .