menu

UWP

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TreeGridToExcelConverter - UWP API Reference | Syncfusion

    Show / Hide Table of Contents

    Class TreeGridToExcelConverter

    Provides the base implementation to export the SfTreeGrid to Excel.

    Inheritance
    System.Object
    TreeGridToExcelConverter
    Namespace: Syncfusion.UI.Xaml.TreeGrid.Converter
    Assembly: Syncfusion.SfGridConverter.UWP.dll
    Syntax
    public class TreeGridToExcelConverter : Object
    Remarks

    It provides the set of public and virtual methods to customize the rows and columns while exporting.

    Constructors

    TreeGridToExcelConverter()

    Declaration
    public TreeGridToExcelConverter()

    Fields

    ColumnFormat

    Stores column names and its format.

    Declaration
    protected Dictionary<string, string> ColumnFormat
    Field Value
    Type
    System.Collections.Generic.Dictionary<System.String, System.String>

    PropertyAccessProvider

    Declaration
    protected IPropertyAccessProvider PropertyAccessProvider
    Field Value
    Type
    IPropertyAccessProvider

    Properties

    ExcelColumnIndex

    Gets or sets the column index in worksheet to export the data.

    Declaration
    protected int ExcelColumnIndex { get; set; }
    Property Value
    Type
    System.Int32
    Remarks

    Value will be incremented ExportNodeToExcel once node is exported to export next node.

    ExcelRowIndex

    Gets or sets the row index in worksheet to export the data.

    Declaration
    protected int ExcelRowIndex { get; set; }
    Property Value
    Type
    System.Int32
    Remarks

    Value will be incremented ExportNodeToExcel once node is exported to export next node.

    Methods

    ExportCellToExcel(SfTreeGrid, TreeNode, String, IWorksheet, IRange, TreeGridExcelExportingOptions)

    Declaration
    protected void ExportCellToExcel(SfTreeGrid treeGrid, TreeNode node, string columnName, IWorksheet sheet, IRange excelrange, TreeGridExcelExportingOptions excelExportingOptions)
    Parameters
    Type Name Description
    SfTreeGrid treeGrid
    TreeNode node
    System.String columnName
    IWorksheet sheet
    IRange excelrange
    TreeGridExcelExportingOptions excelExportingOptions

    ExportHeadersToExcel(SfTreeGrid, IWorksheet, TreeGridExcelExportingOptions)

    Declaration
    protected virtual void ExportHeadersToExcel(SfTreeGrid treeGrid, IWorksheet sheet, TreeGridExcelExportingOptions excelExportingOptions)
    Parameters
    Type Name Description
    SfTreeGrid treeGrid
    IWorksheet sheet
    TreeGridExcelExportingOptions excelExportingOptions

    ExportIndentColumn(IWorksheet, TreeGridExcelExportingOptions)

    Declaration
    protected virtual void ExportIndentColumn(IWorksheet sheet, TreeGridExcelExportingOptions excelExportingOptions)
    Parameters
    Type Name Description
    IWorksheet sheet
    TreeGridExcelExportingOptions excelExportingOptions

    ExportNodesToExcel(SfTreeGrid, TreeNodes, IWorksheet, TreeGridExcelExportingOptions)

    Declaration
    protected virtual void ExportNodesToExcel(SfTreeGrid treeGrid, TreeNodes nodes, IWorksheet sheet, TreeGridExcelExportingOptions excelExportingOptions)
    Parameters
    Type Name Description
    SfTreeGrid treeGrid
    TreeNodes nodes
    IWorksheet sheet
    TreeGridExcelExportingOptions excelExportingOptions

    ExportNodeToExcel(SfTreeGrid, TreeNode, IWorksheet, TreeGridExcelExportingOptions)

    Declaration
    protected void ExportNodeToExcel(SfTreeGrid treeGrid, TreeNode node, IWorksheet sheet, TreeGridExcelExportingOptions excelExportingOptions)
    Parameters
    Type Name Description
    SfTreeGrid treeGrid
    TreeNode node
    IWorksheet sheet
    TreeGridExcelExportingOptions excelExportingOptions

    ExportNumberFormatToExcel(IRange, TreeGridColumn, Object)

    Export NumberFormat to excel.

    Declaration
    protected virtual void ExportNumberFormatToExcel(IRange excelrange, TreeGridColumn treeGridColumn, object cellValue)
    Parameters
    Type Name Description
    IRange excelrange
    TreeGridColumn treeGridColumn

    Specifies the TreeGridColumn.

    System.Object cellValue

    Specifies the cell value.

    ExportRowStyle(IRange, IStyle, TreeNode)

    Export the row style to excel.

    Declaration
    protected virtual void ExportRowStyle(IRange excelRange, IStyle style, TreeNode node = null)
    Parameters
    Type Name Description
    IRange excelRange

    Specifies the excel range.

    IStyle style

    Specifies the style.

    TreeNode node

    ExportStackedHeaderToExcel(SfTreeGrid, IWorksheet, TreeGridExcelExportingOptions, StackedHeaderRow)

    Declaration
    protected virtual void ExportStackedHeaderToExcel(SfTreeGrid grid, IWorksheet sheet, TreeGridExcelExportingOptions exportingOptions, StackedHeaderRow stackedHeaderRow)
    Parameters
    Type Name Description
    SfTreeGrid grid
    IWorksheet sheet
    TreeGridExcelExportingOptions exportingOptions
    StackedHeaderRow stackedHeaderRow

    ExportToExcel(SfTreeGrid, TreeGridExcelExportingOptions)

    Declaration
    public virtual ExcelEngine ExportToExcel(SfTreeGrid treeGrid, TreeGridExcelExportingOptions excelExportingOptions)
    Parameters
    Type Name Description
    SfTreeGrid treeGrid
    TreeGridExcelExportingOptions excelExportingOptions
    Returns
    Type
    ExcelEngine

    ExportToExcel(SfTreeGrid, IWorkbook, TreeGridExcelExportingOptions)

    Declaration
    public virtual void ExportToExcel(SfTreeGrid treeGrid, IWorkbook workbook, TreeGridExcelExportingOptions excelExportingOptions)
    Parameters
    Type Name Description
    SfTreeGrid treeGrid
    IWorkbook workbook
    TreeGridExcelExportingOptions excelExportingOptions

    ExportToExcel(SfTreeGrid, IWorksheet, TreeGridExcelExportingOptions)

    Declaration
    public virtual void ExportToExcel(SfTreeGrid treeGrid, IWorksheet sheet, TreeGridExcelExportingOptions excelExportingOptions)
    Parameters
    Type Name Description
    SfTreeGrid treeGrid
    IWorksheet sheet
    TreeGridExcelExportingOptions excelExportingOptions

    ExportToExcelWorksheet(SfTreeGrid, IWorksheet, TreeGridExcelExportingOptions)

    Declaration
    protected virtual void ExportToExcelWorksheet(SfTreeGrid treeGrid, IWorksheet sheet, TreeGridExcelExportingOptions excelExportingOptions)
    Parameters
    Type Name Description
    SfTreeGrid treeGrid
    IWorksheet sheet
    TreeGridExcelExportingOptions excelExportingOptions

    GetMaxLevel(TreeNodes, ref Int32)

    Return the maximum level of the TreeNode.

    Declaration
    protected void GetMaxLevel(TreeNodes nodes, ref int maxlevel)
    Parameters
    Type Name Description
    TreeNodes nodes

    Specifies the collection of node in SfTreeGrid.

    System.Int32 maxlevel

    Specifies the level of TreeNode.

    InitializeCellStyle(SfTreeGrid, IWorksheet, TreeGridExcelExportingOptions)

    Declaration
    protected virtual void InitializeCellStyle(SfTreeGrid treeGrid, IWorksheet sheet, TreeGridExcelExportingOptions excelExportingOptions)
    Parameters
    Type Name Description
    SfTreeGrid treeGrid
    IWorksheet sheet
    TreeGridExcelExportingOptions excelExportingOptions

    SetColumnWidth(SfTreeGrid, IWorksheet, TreeGridExcelExportingOptions)

    Declaration
    protected virtual void SetColumnWidth(SfTreeGrid treeGrid, IWorksheet sheet, TreeGridExcelExportingOptions excelExportingOptions)
    Parameters
    Type Name Description
    SfTreeGrid treeGrid
    IWorksheet sheet
    TreeGridExcelExportingOptions excelExportingOptions

    Extension Methods

    DateTimeExtension.ToDateTime(Object)
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved