Class SfTreeGrid<TValue>

SfTreeGrid is a feature-rich Blazor component used to visualize self-referential or hierarchical data effectively in a tabular format.

Inheritance

System.Object

SfBaseComponent

SfDataBoundComponent

SfTreeGrid<TValue>

Inherited Members

SfDataBoundComponent.SetDataManager<T>(Object)

SfDataBoundComponent.DataManager

SfDataBoundComponent.MainParent

SfBaseComponent.Dispose(Boolean)

Namespace: Syncfusion.Blazor.TreeGrid

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfTreeGrid<TValue> : SfDataBoundComponent, ITreeGrid, ISfCircularComponent

Type Parameters

Name	Description
TValue	A type which provides schema for the treegrid component.

Constructors

SfTreeGrid()

Declaration

public SfTreeGrid()

Properties

Aggregates

Configures the TreeGrid aggregate rows.

Declaration

public List<TreeGridAggregate> Aggregates { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<TreeGridAggregate>

AllowExcelExport

If AllowExcelExport set to true, then it will allow the user to export treegrid to Excel file.

Declaration

public bool AllowExcelExport { get; set; }

Property Value

Type	Description
System.Boolean

AllowFiltering

If AllowFiltering is set to true the filter bar will be displayed. If set to false the filter bar will not be displayed. Filter bar allows the user to filter tree grid records with required criteria.

Declaration

public bool AllowFiltering { get; set; }

Property Value

Type	Description
System.Boolean

AllowMultiSorting

If AllowMultiSorting set to true, then it will allow the user to sort multiple column in the treegrid.

AllowSorting should be true.

Declaration

public bool AllowMultiSorting { get; set; }

Property Value

Type	Description
System.Boolean

AllowPaging

If AllowPaging is set to true, pager renders.

Declaration

public bool AllowPaging { get; set; }

Property Value

Type	Description
System.Boolean

AllowPdfExport

If AllowPdfExport set to true, then it will allow the user to export treegrid to Pdf file.

Declaration

public bool AllowPdfExport { get; set; }

Property Value

Type	Description
System.Boolean

AllowReordering

If AllowReordering is set to true, TreeGrid columns can be reordered. Reordering can be done by drag and drop of a particular column from one index to another index.

If TreeGrid is rendered with stacked headers, reordering is allowed only at the same level as the column headers.

Declaration

public bool AllowReordering { get; set; }

Property Value

Type	Description
System.Boolean

AllowResizing

If AllowResizing is set to true, TreeGrid columns can be resized.

Declaration

public bool AllowResizing { get; set; }

Property Value

Type	Description
System.Boolean

AllowRowDragAndDrop

If AllowRowDragAndDrop is set to true, you can drag and drop treegrid rows at another or within treegrid.

Declaration

public bool AllowRowDragAndDrop { get; set; }

Property Value

Type	Description
System.Boolean

Remarks

To drag and drop rows between treegrid or to another component, TargetID property should be provided with the ID of the target treegrid or any other component.

AllowSelection

If AllowSelection is set to true, it allows selection of (highlight row) TreeGrid records by clicking it.

Declaration

public bool AllowSelection { get; set; }

Property Value

Type	Description
System.Boolean

AllowSorting

If AllowSorting is set to true, it allows sorting of treegrid records when column header is clicked.

Declaration

public bool AllowSorting { get; set; }

Property Value

Type	Description
System.Boolean

AllowTextWrap

If AllowTextWrap set to true, then text content will wrap to the next line when its text content exceeds the width of the Column Cells.

Declaration

public bool AllowTextWrap { get; set; }

Property Value

Type	Description
System.Boolean

AutoCheckHierarchy

If AutoCheckHierarchy is set to true, hierarchy checkbox selection is enabled in TreeGrid.

Declaration

public bool AutoCheckHierarchy { get; set; }

Property Value

Type	Description
System.Boolean

ChildMapping

Specifies the mapping property path for child records in data source.

Declaration

public string ChildMapping { get; set; }

Property Value

Type	Description
System.String

ClipMode

Defines the mode of clip. The available modes are, Clip: Truncates the cell content when it overflows its area. Ellipsis: Displays ellipsis when the cell content overflows its area. EllipsisWithTooltip: Displays ellipsis when the cell content overflows its area, also it will display the tooltip while hover on ellipsis is applied..

Declaration

public ClipMode ClipMode { get; set; }

Property Value

Type	Description
ClipMode

ColumnChooserSettings

Configures the column chooser in the Tree Grid.

Declaration

public TreeGridColumnChooserSettings ColumnChooserSettings { get; set; }

Property Value

Type	Description
TreeGridColumnChooserSettings

ColumnMenuItems

ColumnMenuItems defines both built-in and custom column menu items. The available built-in items are, AutoFitAll - Auto fit the size of all columns. AutoFit - Auto fit the current column. SortAscending - Sort the current column in ascending order. SortDescending - Sort the current column in descending order. Filter - Filter options will show based on filterSettings property like filterbar, menu filter.

Declaration

public object ColumnMenuItems { get; set; }

Property Value

Type	Description
System.Object

ColumnQueryMode

ColumnQueryModeprovides options to retrieves data from the data source.Their types are All: It retrieves whole data source. Schema: retrieves data for all the defined columns in TreeGrid from the data source. ExcludeHidden: retrieves data only for visible columns of TreeGrid from the data Source.

Declaration

public ColumnQueryModeType ColumnQueryMode { get; set; }

Property Value

Type	Description
ColumnQueryModeType

Columns

Defines the schema of dataSource. If the Columns declaration is empty or undefined then the columns are automatically generated from data source.

Declaration

public List<TreeGridColumn> Columns { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<TreeGridColumn>

ContextMenuItems

ContextMenuItems defines both built-in and custom context menu items. The available built-in items are, AutoFitAll - Auto fit the size of all columns. AutoFit - Auto fit the current column. Edit - Edit the current record. Delete - Delete the current record. Save - Save the edited record. Cancel - Cancel the edited state. PdfExport - Export the grid as Pdf format. ExcelExport - Export the grid as Excel format. CsvExport - Export the grid as CSV format. SortAscending - Sort the current column in ascending order. SortDescending - Sort the current column in descending order. FirstPage - Go to the first page. PrevPage - Go to the previous page. LastPage - Go to the last page. NextPage - Go to the next page.

Declaration

public object ContextMenuItems { get; set; }

Property Value

Type	Description
System.Object

CopyHierarchyMode

CopyHierarchyMode Defines the copy clipboard types. The available built-in items are, Parent - Copy the selected data with parent record. Child - Copy the selected data with child record. Both - Copy the selected data with both parent and child record. None - Copy only the selected record.

Declaration

public CopyHierarchyType CopyHierarchyMode { get; set; }

Property Value

Type	Description
CopyHierarchyType

DataSource

It is used to render TreeGrid table rows.

Declaration

public IEnumerable<TValue> DataSource { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<TValue>

DataSourceChanged

Used to notify the datasource change.

Declaration

public EventCallback<IEnumerable<TValue>> DataSourceChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Collections.Generic.IEnumerable<TValue>>

EditSettings

Configures the edit settings.

Declaration

public TreeGridEditSettings EditSettings { get; set; }

Property Value

Type	Description
TreeGridEditSettings

EnableAdaptiveUI

Gets or sets whether to enabled adaptive UI which makes tree grid adaptive to small screens. The Filtering and various actions in tree grid opens the UI for user in a pop-up occupying the entire screen.

Declaration

public bool EnableAdaptiveUI { get; set; }

Property Value

Type	Description
System.Boolean	true if adaptive UI is enabled to display pop-up, for filtering and various features, which occupies the entire screen. The default value is false.

Examples

<SfTreeGrid AllowSorting="true" AllowFiltering="true" EnableAdaptiveUI="true" Toolbar="@(new List<string>() { "Add", "Edit", "Delete", "Cancel", "Update", "Search" })">
       <TreeGridFilterSettings Type="@Syncfusion.Blazor.TreeGrid.FilterType.Excel"></TreeGridFilterSettings>
       <TreeGridEditSettings AllowAdding = "true" AllowEditing="true" AllowDeleting="true" Mode="Syncfusion.Blazor.TreeGrid.EditMode.Dialog"></TreeGridEditSettings>
</SfTreeGrid>

EnableAltRow

If EnableAltRow is set to true, the TreeGrid will render with e-altrow CSS class to the alternative tr elements.

Declaration

public bool EnableAltRow { get; set; }

Property Value

Type	Description
System.Boolean

EnableAutoFill

If EnableAutoFill is set to true, then the auto fill icon will displayed on cell selection for copy cells. It requires the selection mode to be Cell and cellSelectionMode to be Box.

Declaration

public bool EnableAutoFill { get; set; }

Property Value

Type	Description
System.Boolean

EnableCollapseAll

Specifies whether to load all the rows in collapsed state when the TreeGrid is rendered for the first time.

Declaration

public bool EnableCollapseAll { get; set; }

Property Value

Type	Description
System.Boolean

EnableColumnVirtualization

When enabled, tree grid loads large dataset of columns without performance degradation If EnableColumnVirtualization set to true, then the Tree Grid will render only the columns visible within the view-port and load subsequent columns on horizontal scrolling. This helps to load large dataset of columns in Tree Grid.

Declaration

public bool EnableColumnVirtualization { get; set; }

Property Value

Type	Description
System.Boolean

EnableHover

If EnableHover is set to true, the row hover is enabled in the TreeGrid.

Declaration

public bool EnableHover { get; set; }

Property Value

Type	Description
System.Boolean

EnablePersistence

Enable or disable persisting component's state between page reloads.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean

EnableVirtualization

If EnableVirtualization set to true, then the Tree Grid will render only the rows visible within the view-port and load subsequent rows on vertical scrolling. This helps to load large dataset in Tree Grid.

Declaration

public bool EnableVirtualization { get; set; }

Property Value

Type	Description
System.Boolean

ExpandStateMapping

Specifies the mapping property path for the expand status of a record in data source.

Declaration

public string ExpandStateMapping { get; set; }

Property Value

Type	Description
System.String

FilterSettings

Configures the filter settings of the TreeGrid.

Declaration

public TreeGridFilterSettings FilterSettings { get; set; }

Property Value

Type	Description
TreeGridFilterSettings

FrozenColumns

Gets or sets the number of frozen columns.

Declaration

public double FrozenColumns { get; set; }

Property Value

Type	Description
System.Double

FrozenRows

Gets or sets the number of frozen rows.

Declaration

public double FrozenRows { get; set; }

Property Value

Type	Description
System.Double

GridLines

Defines the mode of TreeGrid lines. The available modes are, Both: Displays both horizontal and vertical TreeGrid lines. None: No TreeGrid lines are displayed. Horizontal: Displays the horizontal TreeGrid lines only. Vertical: Displays the vertical TreeGrid lines only. Default: Displays TreeGrid lines based on the theme.

Declaration

public GridLine GridLines { get; set; }

Property Value

Type	Description
GridLine

HasChildMapping

Specifies whether record is parent or not for the remote data binding.

Declaration

public string HasChildMapping { get; set; }

Property Value

Type	Description
System.String

Height

Defines the scrollable height of the TreeGrid content.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String

IdMapping

Specifies the name of the field in the dataSource, which contains the id of that row.

Declaration

public string IdMapping { get; set; }

Property Value

Type	Description
System.String

KeySettings

Configures the cell movement keys in the Grid.

Declaration

public TreeGridKeySettings KeySettings { get; set; }

Property Value

Type	Description
TreeGridKeySettings

LoadChildOnDemand

If LoadChildOnDemand is enabled, parent records are render in expanded state.

Declaration

public bool LoadChildOnDemand { get; set; }

Property Value

Type	Description
System.Boolean

PageSettings

Configures the pager in the TreeGrid.

Declaration

public TreeGridPageSettings PageSettings { get; set; }

Property Value

Type	Description
TreeGridPageSettings

ParentIdMapping

Specifies the name of the field in the dataSource, which contains the parent’s id.

Declaration

public string ParentIdMapping { get; set; }

Property Value

Type	Description
System.String

PrintMode

Defines the print modes. The available print modes are AllPages: Prints all pages of the TreeGrid. CurrentPage: Prints the current page of the TreeGrid.

Declaration

public PrintMode PrintMode { get; set; }

Property Value

Type	Description
PrintMode

Query

Defines the external Query that will be executed along with data processing.

Declaration

public Query Query { get; set; }

Property Value

Type	Description
Query

Remarks

Additional parameters can be send along with request by using AddParams(String, Object) method.

RowDropSettings

Configures the row drop settings of the TreeGrid.

Declaration

public TreeGridRowDropSettings RowDropSettings { get; set; }

Property Value

Type	Description
TreeGridRowDropSettings

RowHeight

Defines the height of TreeGrid rows.

Declaration

public double RowHeight { get; set; }

Property Value

Type	Description
System.Double

SearchSettings

Configures the search settings of the TreeGrid.

Declaration

public TreeGridSearchSettings SearchSettings { get; set; }

Property Value

Type	Description
TreeGridSearchSettings

SelectedRowIndex

The SelectedRowIndex allows you to select a row at initial rendering. You can also get the currently selected row index.

Declaration

public double SelectedRowIndex { get; set; }

Property Value

Type	Description
System.Double

SelectionSettings

Configures the selection settings.

Declaration

public TreeGridSelectionSettings SelectionSettings { get; set; }

Property Value

Type	Description
TreeGridSelectionSettings

ShowColumnChooser

If ShowColumnChooser is set to true, it allows you to dynamically show or hide columns.

Declaration

public bool ShowColumnChooser { get; set; }

Property Value

Type	Description
System.Boolean

ShowColumnMenu

If ShowColumnMenu set to true, then it will enable the column menu options in each columns.

Declaration

public bool ShowColumnMenu { get; set; }

Property Value

Type	Description
System.Boolean

SortSettings

Configures the sort settings of the TreeGrid.

Declaration

public TreeGridSortSettings SortSettings { get; set; }

Property Value

Type	Description
TreeGridSortSettings

TextWrapSettings

Configures the text wrap in the TreeGrid.

Declaration

public TreeGridTextWrapSettings TextWrapSettings { get; set; }

Property Value

Type	Description
TreeGridTextWrapSettings

Toolbar

Toolbar defines the ToolBar items of the TreeGrid. It contains built-in and custom toolbar items. If a string value is assigned to the toolbar option, it is considered as the template for the whole TreeGrid ToolBar. If an array value is assigned, it is considered as the list of built-in and custom toolbar items in the TreeGrid's Toolbar. The following code example implements the custom toolbar items.

Declaration

public object Toolbar { get; set; }

Property Value

Type	Description
System.Object

TreeColumnIndex

Specifies the index of the column that needs to have the expander button.

Declaration

public double TreeColumnIndex { get; set; }

Property Value

Type	Description
System.Double

UnmatchedAttributes

Catches unmatched attributes from the component. This can be used to specify custom style, class and other attributes to the grid.

Declaration

public IDictionary<string, object> UnmatchedAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

Width

Defines the TreeGrid width.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String

Methods

AddRecordAsync()

Adds a new record to the TreeGrid. If no data is passed then add form will be showed.

TreeGridEditSettings.AllowAdding should be true.

Declaration

public Task AddRecordAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

AddRecordAsync(TValue, Nullable<Double>, Nullable<RowPosition>)

Adds a new record to the TreeGrid. Without passing parameters, it adds empty rows.

TreeGridEditSettings.AllowAdding should be true.

Declaration

public Task AddRecordAsync(TValue data, Nullable<double> index = null, Nullable<RowPosition> position = null)

Parameters

Type	Name	Description
TValue	data	Specify the new record to be added.
System.Nullable<System.Double>	index	Specify the index in which new record is to be added.
System.Nullable<RowPosition>	position	Specify the position in which new rocord is to be added.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

AutoFitColumnsAsync(String[])

Changes the column width to automatically fit its content to ensure that the width shows the content without wrapping/hiding.

This method ignores the hidden columns. Uses the AutoFitColumns method in the dataBound event to resize at initial rendering.

Declaration

public Task AutoFitColumnsAsync(string[] fieldNames)

Parameters

Type	Name	Description
System.String[]	fieldNames	Specify the column names to autofit.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

ClearFilteringAsync()

Clears all the filtered rows of the Grid.

Declaration

public Task ClearFilteringAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ClearFilteringAsync(List<String>)

Clears all the filtered rows of the Grid.

Declaration

public Task ClearFilteringAsync(List<string> fields)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.String>	fields	Specify the field name to be cleared.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ClearSelectionAsync()

Deselects the current selected rows and cells.

Declaration

public Task ClearSelectionAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ClearSortingAsync()

Clears all the sorted columns of the TreeGrid.

Declaration

public Task ClearSortingAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

CloseEditAsync()

Cancels edited state.

Declaration

public Task CloseEditAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

CollapseAllAsync()

Collapses All the rows.

Declaration

public Task CollapseAllAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

CollapseAtLevelAsync(Double)

Collapses the records at specific hierarchical level.

Declaration

public Task CollapseAtLevelAsync(double level)

Parameters

Type	Name	Description
System.Double	level	Specify the level of the records to be collapsed.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

CollapseByKeyAsync(Object)

Collapses the records by primary key value.

Declaration

public Task CollapseByKeyAsync(object key)

Parameters

Type	Name	Description
System.Object	key	Specify the primary key value of the record to be collapsed.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

Examples

<button id="collapseKey" @onclick="CollapseKey">CollapseKey</button>
<SfTreeGrid @ref="TreeGrid" DataSource="@TreeData">
 ........
</SfTreeGrid>
@code{
   SfTreeGrid<HierarchyData> TreeGrid;
   private async Task CollapseKey()
   {
       await this.TreeGrid.CollapseByKeyAsync(12); /// pass primary key value here
  }
}

CollapseRowAsync(TValue)

Collapses child rows.

Declaration

public Task CollapseRowAsync(TValue record)

Parameters

Type	Name	Description
TValue	record	Specify the record to be collapsed.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

CopyAsync(Nullable<Boolean>)

Copy the selected rows or cells data into clipboard.

Declaration

public Task CopyAsync(Nullable<bool> withHeader = null)

Parameters

Type	Name	Description
System.Nullable<System.Boolean>	withHeader	Specifies whether to copy the record with header.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

DeleteRecordAsync()

Delete a record with Given options. If fieldname and data is not given then grid will delete the selected record. TreeGridEditSettings.AllowDeleting should be true.

Declaration

public Task DeleteRecordAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

DeleteRecordAsync(String, TValue)

Delete a record with Given options. If fieldName and data is not given then TreeGrid will delete the selected record.

TreeGridEditSettings.AllowDeleting should be true.

Declaration

public Task DeleteRecordAsync(string fieldName, TValue data)

Parameters

Type	Name	Description
System.String	fieldName	Specify the field name of the primary key column.
TValue	data	Specify the record to be deleted.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

Dispose()

Dispose unmanaged resources in the component.

Declaration

public override void Dispose()

Overrides

SfBaseComponent.Dispose()

EditCellAsync(Double, String)

To edit any particular cell using row index and cell index.

Declaration

public Task EditCellAsync(double rowIndex, string field)

Parameters

Type	Name	Description
System.Double	rowIndex	Specify the index of the row to be deleted.
System.String	field	Specify the field name of the cell to be deleted.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

EnableToolbarItemsAsync(List<String>, Boolean)

Enables or disables ToolBar items.

Declaration

public Task EnableToolbarItemsAsync(List<string> items, bool isEnable)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.String>	items	Specify the toolbar items to be enabled or disabled.
System.Boolean	isEnable	Specify whether the given items should be enabled or disabled.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

EndEditAsync()

If TreeGrid is in editable state, you can save a record by invoking endEdit.

Declaration

public Task EndEditAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExpandAllAsync()

Expands All the rows.

Declaration

public Task ExpandAllAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExpandAtLevelAsync(Double)

Expands the records at specific hierarchical level.

Declaration

public Task ExpandAtLevelAsync(double level)

Parameters

Type	Name	Description
System.Double	level	Specify the level of the records to be expanded.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExpandByKeyAsync(Object)

Expands the records by primary key value.

Declaration

public Task ExpandByKeyAsync(object key)

Parameters

Type	Name	Description
System.Object	key	Specify the primary key value of the record to be expanded.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

Examples

<SfTreeGrid @ref="TreeGrid" DataSource="@TreeData">
<button id="expandKey" @onclick="ExpandKey">ExpandKey</button>
<SfTreeGrid @ref="TreeGrid" DataSource="@TreeData">
 ........
</SfTreeGrid>
@code{
   SfTreeGrid<HierarchyData> TreeGrid;
   private async Task ExpandKey()
   {
        await this.TreeGrid.ExpandByKeyAsync(12); /// pass primary key value here.
   }
}

ExpandRowAsync(TValue)

Expands child rows.

Declaration

public Task ExpandRowAsync(TValue record)

Parameters

Type	Name	Description
TValue	record	Specify the record to be expanded.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExportToCsvAsync(ExcelExportProperties, Nullable<Boolean>, Object, Nullable<Boolean>)

Export TreeGrid data to CSV file.

Declaration

public Task ExportToCsvAsync(ExcelExportProperties excelExportProperties = null, Nullable<bool> isMultipleExport = null, object workbook = null, Nullable<bool> isBlob = null)

Parameters

Type	Name	Description
ExcelExportProperties	excelExportProperties	Provides the excel export properties. Use this to provide custom column, data source, theme etc.
System.Nullable<System.Boolean>	isMultipleExport	Specifies multi-export is enabled.
System.Object	workbook	Workbook instance.
System.Nullable<System.Boolean>	isBlob	Export as blob instead of writing response.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExportToExcelAsync()

Export TreeGrid data to Excel file(.xlsx).

Declaration

public Task ExportToExcelAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExportToExcelAsync(ExcelExportProperties, Nullable<Boolean>, Object, Nullable<Boolean>)

Export TreeGrid data to Excel file with customization(.xlsx).

Declaration

public Task ExportToExcelAsync(ExcelExportProperties excelExportProperties = null, Nullable<bool> isMultipleExport = null, object workbook = null, Nullable<bool> isBlob = null)

Parameters

Type	Name	Description
ExcelExportProperties	excelExportProperties	Provides the excel export properties. Use this to provide custom column, data source, theme etc.
System.Nullable<System.Boolean>	isMultipleExport	Specifies multi-export is enabled.
System.Object	workbook	Workbook instance.
System.Nullable<System.Boolean>	isBlob	Export as blob instead of writing response.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExportToExcelAsync(TreeGridExcelExportProperties, Nullable<Boolean>, Object, Nullable<Boolean>)

Export TreeGrid data to Excel file with Tree Grid Customization(.xlsx).

Declaration

public Task ExportToExcelAsync(TreeGridExcelExportProperties excelExportProperties = null, Nullable<bool> isMultipleExport = null, object workbook = null, Nullable<bool> isBlob = null)

Parameters

Type	Name	Description
TreeGridExcelExportProperties	excelExportProperties	Specify the properties of the exported excel document.
System.Nullable<System.Boolean>	isMultipleExport	Specify whether multiple documents are exported.
System.Object	workbook	Specify the workbook to be exported.
System.Nullable<System.Boolean>	isBlob	Specify whether the exported document is a blob.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExportToPdfAsync()

Export TreeGrid data to PDF document.

Declaration

public Task ExportToPdfAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExportToPdfAsync(PdfExportProperties, Nullable<Boolean>, Object, Nullable<Boolean>)

Export TreeGrid data to PDF document with Customization.

Declaration

public Task ExportToPdfAsync(PdfExportProperties pdfExportProperties = null, Nullable<bool> isMultipleExport = null, object pdfDoc = null, Nullable<bool> isBlob = null)

Parameters

Type	Name	Description
PdfExportProperties	pdfExportProperties	Provides the pdf export properties. Use this to provide custom column, data source, theme etc.
System.Nullable<System.Boolean>	isMultipleExport	Specifies multi-export is enabled.
System.Object	pdfDoc	PDF document instance.
System.Nullable<System.Boolean>	isBlob	Export as blob instead of writing response.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ExportToPdfAsync(TreeGridPdfExportProperties, Nullable<Boolean>, Object, Nullable<Boolean>)

Export TreeGrid data to PDF document with Tree Grid Customization.

Declaration

public Task ExportToPdfAsync(TreeGridPdfExportProperties pdfExportProperties = null, Nullable<bool> isMultipleExport = null, object pdfDoc = null, Nullable<bool> isBlob = null)

Parameters

Type	Name	Description
TreeGridPdfExportProperties	pdfExportProperties	Provides the pdf export properties. Use this to provide custom column, data source, theme etc.
System.Nullable<System.Boolean>	isMultipleExport	Specifies multi-export is enabled.
System.Object	pdfDoc	PDF document instance.
System.Nullable<System.Boolean>	isBlob	Export as blob instead of writing response.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

FilterByColumnAsync(String, String, Object, String, Nullable<Boolean>, Nullable<Boolean>, String, String)

Filters TreeGrid row by column name with the given options.

Declaration

public Task FilterByColumnAsync(string fieldName, string filterOperator, object filterValue, string predicate = null, Nullable<bool> matchCase = null, Nullable<bool> ignoreAccent = null, string actualFilterValue = null, string actualOperator = null)

Parameters

Type	Name	Description
System.String	fieldName	Specifies the field name to be filtered.
System.String	filterOperator	Sepcifies the filter operator.
System.Object	filterValue	Specifies the filter value.
System.String	predicate	Specifies predicate/condition such as AND/OR while filtering multiple value.
System.Nullable<System.Boolean>	matchCase	Specifies the match case.
System.Nullable<System.Boolean>	ignoreAccent	Specifies the ignore accent.
System.String	actualFilterValue	Specifies the actual value.
System.String	actualOperator	Specifies the actual type.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

FocusAsync()

Focuses the Tree Grid Element.

Declaration

public Task FocusAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

GetBatchChangesAsync()

Gets the added, edited,and deleted data before bulk save to the DataSource in batch mode.

Declaration

public Task<BatchChanges<TValue>> GetBatchChangesAsync()

Returns

Type	Description
System.Threading.Tasks.Task<BatchChanges<TValue>>	System.Threading.Tasks.Task.

GetCheckedRecordsAsync()

Get the records of checked rows.

Declaration

public Task<List<TValue>> GetCheckedRecordsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<TValue>>	System.Threading.Tasks.Task.

GetCheckedRowIndexes()

Get the indexes of checked rows.

Declaration

public Task<List<double>> GetCheckedRowIndexes()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<System.Double>>	System.Threading.Tasks.Task.

GetColumnByFieldAsync(String)

Gets a Column by column name.

Declaration

public Task<TreeGridColumn> GetColumnByFieldAsync(string field)

Parameters

Type	Name	Description
System.String	field	Specify the filed name of the column to be obtained.

Returns

Type	Description
System.Threading.Tasks.Task<TreeGridColumn>	System.Threading.Tasks.Task.

GetColumnByUidAsync(String)

Gets a column by UID.

Declaration

public Task<TreeGridColumn> GetColumnByUidAsync(string uid)

Parameters

Type	Name	Description
System.String	uid	Specify the uid value of the column to be obtained.

Returns

Type	Description
System.Threading.Tasks.Task<TreeGridColumn>	System.Threading.Tasks.Task.

GetColumnFieldNamesAsync()

Gets the collection of column fields.

Declaration

public Task<List<string>> GetColumnFieldNamesAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<System.String>>	System.Threading.Tasks.Task.

GetColumnIndexByFieldAsync(String)

Gets a column index by column name.

Declaration

public Task<double> GetColumnIndexByFieldAsync(string field)

Parameters

Type	Name	Description
System.String	field	Specify the field name of the column.

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>	System.Threading.Tasks.Task.

GetColumnIndexByUidAsync(String)

Gets a column index by UID.

Declaration

public Task<double> GetColumnIndexByUidAsync(string uid)

Parameters

Type	Name	Description
System.String	uid	Specify the uid value of the column.

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>	System.Threading.Tasks.Task.

GetColumnsAsync()

Gets the columns from the TreeGrid.

Declaration

public Task<List<TreeGridColumn>> GetColumnsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<TreeGridColumn>>	System.Threading.Tasks.Task.

GetCurrentViewRecords()

Get current visible data of TreeGrid.

Declaration

public List<TValue> GetCurrentViewRecords()

Returns

Type	Description
System.Collections.Generic.List<TValue>	System.Threading.Tasks.Task.

GetPrimaryKeyFieldNamesAsync()

Get the names of the primary key columns of the TreeGrid.

Declaration

public Task<List<string>> GetPrimaryKeyFieldNamesAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<System.String>>	System.Threading.Tasks.Task.

GetRowIndexByPrimaryKeyAsync(Object)

Get row index by primary key.

Declaration

public Task<double> GetRowIndexByPrimaryKeyAsync(object value)

Parameters

Type	Name	Description
System.Object	value	Primary key value.

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>	System.Threading.Tasks.Task.

GetSelectedRecordsAsync()

Gets the collection of selected records.

Declaration

public Task<List<TValue>> GetSelectedRecordsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<TValue>>	System.Threading.Tasks.Task.

GetSelectedRowCellIndexesAsync()

Gets the collection of selected row and cell indexes.

Declaration

public Task<List<ValueTuple<double, double>>> GetSelectedRowCellIndexesAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<System.ValueTuple<System.Double, System.Double>>>	System.Threading.Tasks.Task.

GetSelectedRowIndexesAsync()

Gets the collection of selected row indexes.

Declaration

public Task<List<double>> GetSelectedRowIndexesAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<System.Double>>	System.Threading.Tasks.Task.

GetUidByColumnFieldAsync(String)

Gets UID by column name.

Declaration

public Task<string> GetUidByColumnFieldAsync(string field)

Parameters

Type	Name	Description
System.String	field	Specify the filed name of the column.

Returns

Type	Description
System.Threading.Tasks.Task<System.String>	System.Threading.Tasks.Task.

GetVisibleColumnsAsync()

Gets the visible columns from the TreeGrid.

Declaration

public Task<List<TreeGridColumn>> GetVisibleColumnsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Collections.Generic.List<TreeGridColumn>>	System.Threading.Tasks.Task.

GoToPageAsync(Double)

Navigates to the specified target page.

Declaration

public Task GoToPageAsync(double pageNo)

Parameters

Type	Name	Description
System.Double	pageNo	Specify the page number you want to navigate.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

HideColumnAsync(String, String)

Hides a column by column name.

Declaration

public Task HideColumnAsync(string key, string hideBy = "HeaderText")

Parameters

Type	Name	Description
System.String	key	Specifies the column names.
System.String	hideBy	Specifies the column getting criteria.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

HideColumnsAsync(String[], String)

Hides a column by column name.

Declaration

public Task HideColumnsAsync(string[] keys, string hideBy = "HeaderText")

Parameters

Type	Name	Description
System.String[]	keys	Specifies the column names.
System.String	hideBy	Specifies the column getting criteria.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

HideSpinnerAsync()

Manually shown spinner needs to hide by HideSpinnner.

Declaration

public Task HideSpinnerAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

OnAfterRenderAsync(Boolean)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

SfDataBoundComponent.OnAfterRenderAsync(Boolean)

OnInitializedAsync()

Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree. Override this method if you will perform an asynchronous operation and want the component to refresh when that operation is completed.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing any asynchronous operation.

Overrides

SfDataBoundComponent.OnInitializedAsync()

OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

Declaration

protected override void OnObservableChange(string propertyName, object sender, bool isCollectionChanged = false, NotifyCollectionChangedEventArgs e = null)

Parameters

Type	Name	Description
System.String	propertyName
System.Object	sender
System.Boolean	isCollectionChanged
System.Collections.Specialized.NotifyCollectionChangedEventArgs	e

Overrides

SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task	A System.Threading.Tasks.Task representing any asynchronous operation.

Overrides

SfDataBoundComponent.OnParametersSetAsync()

OpenColumnChooserAsync(Nullable<Double>, Nullable<Double>)

Column chooser can be displayed on screen by given position(X and Y axis).

Declaration

public Task OpenColumnChooserAsync(Nullable<double> x = null, Nullable<double> y = null)

Parameters

Type	Name	Description
System.Nullable<System.Double>	x	Specifies the X position.
System.Nullable<System.Double>	y	Specifies the Y position.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

PasteAsync(String, Double, Double)

Paste data from clipboard to selected cells.

Declaration

public Task PasteAsync(string data, double rowIndex, double colIndex)

Parameters

Type	Name	Description
System.String	data	Specifies the record to be pasted.
System.Double	rowIndex	Specifies the row index.
System.Double	colIndex	Specifies the column index.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

PreventRender(Boolean)

Prevents the Tree Grid render. This method will internally sets value to be returned from ShouldRender method.

Declaration

public void PreventRender(bool preventRender = true)

Parameters

Type	Name	Description
System.Boolean	preventRender	Default value is true. Toggles the ShouldRender method value.

PrintAsync()

By default, prints all the pages of the TreeGrid and hides the pager. You can customize print options using the PrintMode.

Declaration

public Task PrintAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

RefreshAsync()

Refreshes the tree grid header and content.

Declaration

public Task RefreshAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

RefreshColumnsAsync()

Refreshes the TreeGrid column changes.

Declaration

public Task RefreshColumnsAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

RefreshHeaderAsync()

Refreshes the TreeGrid header.

Declaration

public Task RefreshHeaderAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ReorderColumnsAsync(List<String>, String)

Changes the Grid column positions by field names.

Declaration

public Task ReorderColumnsAsync(List<string> fromFName, string toFName)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.String>	fromFName	Specifies the list of field names to be moved.
System.String	toFName	Specifies the field name of the destination location.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ReorderRowAsync(Double, Double, String)

Changes the Tree Grid Row position with given indexes.

Declaration

public Task ReorderRowAsync(double fromIndex, double toIndex, string position = null)

Parameters

Type	Name	Description
System.Double	fromIndex	Specifies the start row index.
System.Double	toIndex	Specifies the to row index.
System.String	position	Specifies the position of the row to be reordered.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SaveCellAsync()

Saves the cell that is currently edited. It does not save the value to the DataSource.

Declaration

public Task SaveCellAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SearchAsync(String)

Searches TreeGrid records using the given key.

Declaration

public Task SearchAsync(string searchString)

Parameters

Type	Name	Description
System.String	searchString	Specifies the search key.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SelectCellAsync(ValueTuple<Int32, Int32>, Nullable<Boolean>)

Selects a cell by the given index.

Declaration

public Task SelectCellAsync(ValueTuple<int, int> cellIndex, Nullable<bool> isToggle = null)

Parameters

Type	Name	Description
System.ValueTuple<System.Int32, System.Int32>	cellIndex	Specifies the ValueTuple of row and cell index. Example: (0, 1).
System.Nullable<System.Boolean>	isToggle	Toggles the selection.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SelectCheckboxesAsync(Double[])

Checked the checkboxes using rowIndexes.

Declaration

public Task SelectCheckboxesAsync(double[] rowIndexes)

Parameters

Type	Name	Description
System.Double[]	rowIndexes	Specifies the indexes of checkbox rows to be selected.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SelectRowAsync(Double, Nullable<Boolean>)

Selects a row by given index.

Declaration

public Task SelectRowAsync(double index, Nullable<bool> isToggle = null)

Parameters

Type	Name	Description
System.Double	index	Specifies the row index to select.
System.Nullable<System.Boolean>	isToggle	Toggles the selection.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SelectRowsAsync(Double[])

Selects a collection of rows by indexes.

Declaration

public Task SelectRowsAsync(double[] rowIndexes)

Parameters

Type	Name	Description
System.Double[]	rowIndexes	Specifies the indexes of rows to be selected.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SetCellValueAsync(Object, String, Object)

Updates particular cell value based on the given primary key value.

Primary key column must be specified using Columns.isPrimaryKey property.

Declaration

public Task SetCellValueAsync(object key, string field, object value)

Parameters

Type	Name	Description
System.Object	key	Specifies the primary key value.
System.String	field	Specifies the key field name.
System.Object	value	Specifies the new value.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SetIndentRecordAsync(TValue)

Indent the selected or specified record based on its level.

Declaration

public Task SetIndentRecordAsync(TValue data)

Parameters

Type	Name	Description
TValue	data	Specify the record which needs to be indented.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SetOutdentRecordAsync(TValue, Boolean)

Outdent the selected or specified record based on its level.

Declaration

public Task SetOutdentRecordAsync(TValue data, bool IsUpdateSiblingRows = false)

Parameters

Type	Name	Description
TValue	data	Specify the record which needs to be outdented.
System.Boolean	IsUpdateSiblingRows	Optional boolean value, which specify whether to indent the sibling record as child to selected record.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SetRowDataAsync(Object, TValue)

Updates and refresh the particular row values based on the given primary key value.

Primary key column must be specified using Columns.isPrimaryKey property.

Declaration

public Task SetRowDataAsync(object primaryKey, TValue rowData)

Parameters

Type	Name	Description
System.Object	primaryKey	Specifies the PrimaryKey value of dataSource.
TValue	rowData	To update new data for the particular row.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ShouldRender()

Declaration

protected override bool ShouldRender()

Returns

Type	Description
System.Boolean

ShowColumnAsync(String, String)

Shows a column by its column name.

Declaration

public Task ShowColumnAsync(string key, string showBy = "HeaderText")

Parameters

Type	Name	Description
System.String	key	Specifies the column names.
System.String	showBy	Specifies the column getting criteria.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ShowColumnsAsync(String[], String)

Shows a column by its column name.

Declaration

public Task ShowColumnsAsync(string[] keys, string showBy = "HeaderText")

Parameters

Type	Name	Description
System.String[]	keys	Specifies the column names.
System.String	showBy	Specifies the column getting criteria.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

ShowSpinnerAsync()

By default, TreeGrid shows the spinner for all its actions. You can use this method to show spinner at your needed time.

Declaration

public Task ShowSpinnerAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

SortByColumnAsync(String, SortDirection, Nullable<Boolean>)

Sorts a column with the given options.

Declaration

public Task SortByColumnAsync(string columnName, SortDirection direction, Nullable<bool> isMultiSort = null)

Parameters

Type	Name	Description
System.String	columnName	Specifies the sort column name.
SortDirection	direction	Specifies the sort direction.
System.Nullable<System.Boolean>	isMultiSort	Specifies whether its multi-sorting.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

StartEditAsync()

To edit any particular row by TR element.

Declaration

public Task StartEditAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

UpdateCellAsync(Double, String, Object)

To update the specified cell by given value without changing into edited state.

Declaration

public Task UpdateCellAsync(double rowIndex, string field, object value)

Parameters

Type	Name	Description
System.Double	rowIndex	Specifies the row index.
System.String	field	Specifies the column name.
System.Object	value	Specifies the new value.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

UpdateExternalMessageAsync(String)

Defines the text of external message.

Declaration

public Task UpdateExternalMessageAsync(string message)

Parameters

Type	Name	Description
System.String	message	Specifies the externam message.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.

UpdateRowAsync(Double, TValue)

To update the specified row by given values without changing into edited state.

Declaration

public Task UpdateRowAsync(double index, TValue data)

Parameters

Type	Name	Description
System.Double	index	Specifies the row index.
TValue	data	Specifies the updated data.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task.