Class TreeGridBuilder

Inheritance
System.Object
ControlBuilder
TreeGridBuilder
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.EJ2.TreeGrid
Assembly: Syncfusion.EJ2.dll
Syntax
public class TreeGridBuilder : ControlBuilder

Constructors

TreeGridBuilder()

Declaration
public TreeGridBuilder()

TreeGridBuilder(TreeGrid)

Declaration
public TreeGridBuilder(TreeGrid model)
Parameters
Type Name Description
TreeGrid model

Fields

model

Declaration
public TreeGrid model
Field Value
Type Description
TreeGrid

Properties

HtmlAttr

Declaration
public IDictionary<string, object> HtmlAttr { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

Declaration
public string ID { get; set; }
Property Value
Type Description
System.String

Output

Declaration
public override TextWriter Output { get; set; }
Property Value
Type Description
System.IO.TextWriter
Overrides

Methods

ActionBegin(String)

Triggers when TreeGrid actions such as sorting, filtering, paging etc., starts.

Declaration
public TreeGridBuilder ActionBegin(string actionBegin)
Parameters
Type Name Description
System.String actionBegin
Returns
Type Description
TreeGridBuilder

ActionComplete(String)

Triggers when TreeGrid actions such as sorting, filtering, paging etc. are completed.

Declaration
public TreeGridBuilder ActionComplete(string actionComplete)
Parameters
Type Name Description
System.String actionComplete
Returns
Type Description
TreeGridBuilder

ActionFailure(String)

Triggers when any TreeGrid action failed to achieve the desired results.

Declaration
public TreeGridBuilder ActionFailure(string actionFailure)
Parameters
Type Name Description
System.String actionFailure
Returns
Type Description
TreeGridBuilder

Aggregates(Action<TreeGridAggregateBuilder>)

Declaration
public TreeGridBuilder Aggregates(Action<TreeGridAggregateBuilder> aggregates)
Parameters
Type Name Description
System.Action<TreeGridAggregateBuilder> aggregates
Returns
Type Description
TreeGridBuilder

Aggregates(List<TreeGridAggregate>)

Configures the TreeGrid aggregate rows.

Check the Aggregates for its configuration.

Declaration
public TreeGridBuilder Aggregates(List<TreeGridAggregate> aggregates)
Parameters
Type Name Description
System.Collections.Generic.List<TreeGridAggregate> aggregates
Returns
Type Description
TreeGridBuilder

AllowExcelExport(Boolean)

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

Declaration
public TreeGridBuilder AllowExcelExport(bool allowExcelExport = true)
Parameters
Type Name Description
System.Boolean allowExcelExport
Returns
Type Description
TreeGridBuilder

AllowFiltering(Boolean)

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 TreeGridBuilder AllowFiltering(bool allowFiltering = true)
Parameters
Type Name Description
System.Boolean allowFiltering
Returns
Type Description
TreeGridBuilder

AllowMultiSorting(Boolean)

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

allowSorting should be true.

Declaration
public TreeGridBuilder AllowMultiSorting(bool allowMultiSorting = true)
Parameters
Type Name Description
System.Boolean allowMultiSorting
Returns
Type Description
TreeGridBuilder

AllowPaging(Boolean)

If allowPaging is set to true, pager renders.

Declaration
public TreeGridBuilder AllowPaging(bool allowPaging = true)
Parameters
Type Name Description
System.Boolean allowPaging
Returns
Type Description
TreeGridBuilder

AllowPdfExport(Boolean)

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

Declaration
public TreeGridBuilder AllowPdfExport(bool allowPdfExport = true)
Parameters
Type Name Description
System.Boolean allowPdfExport
Returns
Type Description
TreeGridBuilder

AllowReordering(Boolean)

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 TreeGridBuilder AllowReordering(bool allowReordering = true)
Parameters
Type Name Description
System.Boolean allowReordering
Returns
Type Description
TreeGridBuilder

AllowResizing(Boolean)

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

Declaration
public TreeGridBuilder AllowResizing(bool allowResizing = true)
Parameters
Type Name Description
System.Boolean allowResizing
Returns
Type Description
TreeGridBuilder

AllowRowDragAndDrop(Boolean)

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

Declaration
public TreeGridBuilder AllowRowDragAndDrop(bool allowRowDragAndDrop = true)
Parameters
Type Name Description
System.Boolean allowRowDragAndDrop
Returns
Type Description
TreeGridBuilder

AllowSelection(Boolean)

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

Declaration
public TreeGridBuilder AllowSelection(bool allowSelection = true)
Parameters
Type Name Description
System.Boolean allowSelection
Returns
Type Description
TreeGridBuilder

AllowSorting(Boolean)

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

Declaration
public TreeGridBuilder AllowSorting(bool allowSorting = true)
Parameters
Type Name Description
System.Boolean allowSorting
Returns
Type Description
TreeGridBuilder

AllowTextWrap(Boolean)

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 TreeGridBuilder AllowTextWrap(bool allowTextWrap = true)
Parameters
Type Name Description
System.Boolean allowTextWrap
Returns
Type Description
TreeGridBuilder

AutoCheckHierarchy(Boolean)

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

Declaration
public TreeGridBuilder AutoCheckHierarchy(bool autoCheckHierarchy = true)
Parameters
Type Name Description
System.Boolean autoCheckHierarchy
Returns
Type Description
TreeGridBuilder

BatchAdd(String)

Triggers when records are added in batch mode.

Declaration
public TreeGridBuilder BatchAdd(string batchAdd)
Parameters
Type Name Description
System.String batchAdd
Returns
Type Description
TreeGridBuilder

BatchCancel(String)

Triggers before records are added in batch mode.

Declaration
public TreeGridBuilder BatchCancel(string batchCancel)
Parameters
Type Name Description
System.String batchCancel
Returns
Type Description
TreeGridBuilder

BatchDelete(String)

Triggers when records are deleted in batch mode.

Declaration
public TreeGridBuilder BatchDelete(string batchDelete)
Parameters
Type Name Description
System.String batchDelete
Returns
Type Description
TreeGridBuilder

BeforeBatchAdd(String)

Triggers before records are added in batch mode.

Declaration
public TreeGridBuilder BeforeBatchAdd(string beforeBatchAdd)
Parameters
Type Name Description
System.String beforeBatchAdd
Returns
Type Description
TreeGridBuilder

BeforeBatchDelete(String)

Triggers before records are deleted in batch mode.

Declaration
public TreeGridBuilder BeforeBatchDelete(string beforeBatchDelete)
Parameters
Type Name Description
System.String beforeBatchDelete
Returns
Type Description
TreeGridBuilder

BeforeBatchSave(String)

Triggers before records are saved in batch mode.

Declaration
public TreeGridBuilder BeforeBatchSave(string beforeBatchSave)
Parameters
Type Name Description
System.String beforeBatchSave
Returns
Type Description
TreeGridBuilder

BeforeCopy(String)

Triggers before TreeGrid copy action.

Declaration
public TreeGridBuilder BeforeCopy(string beforeCopy)
Parameters
Type Name Description
System.String beforeCopy
Returns
Type Description
TreeGridBuilder

BeforeDataBound(String)

Triggers before data is bound to Tree Grid.

Declaration
public TreeGridBuilder BeforeDataBound(string beforeDataBound)
Parameters
Type Name Description
System.String beforeDataBound
Returns
Type Description
TreeGridBuilder

BeforeExcelExport(String)

Triggers before TreeGrid data is exported to Excel file.

Declaration
public TreeGridBuilder BeforeExcelExport(string beforeExcelExport)
Parameters
Type Name Description
System.String beforeExcelExport
Returns
Type Description
TreeGridBuilder

BeforePaste(String)

Triggers before TreeGrid paste action.

Declaration
public TreeGridBuilder BeforePaste(string beforePaste)
Parameters
Type Name Description
System.String beforePaste
Returns
Type Description
TreeGridBuilder

BeforePdfExport(String)

Triggers before TreeGrid data is exported to PDF document.

Declaration
public TreeGridBuilder BeforePdfExport(string beforePdfExport)
Parameters
Type Name Description
System.String beforePdfExport
Returns
Type Description
TreeGridBuilder

BeforePrint(String)

Triggers before the print action starts.

Declaration
public TreeGridBuilder BeforePrint(string beforePrint)
Parameters
Type Name Description
System.String beforePrint
Returns
Type Description
TreeGridBuilder

BeginEdit(String)

Triggers before the record is to be edit.

Declaration
public TreeGridBuilder BeginEdit(string beginEdit)
Parameters
Type Name Description
System.String beginEdit
Returns
Type Description
TreeGridBuilder

CellDeselected(String)

Triggers when a particular selected cell is deselected.

Declaration
public TreeGridBuilder CellDeselected(string cellDeselected)
Parameters
Type Name Description
System.String cellDeselected
Returns
Type Description
TreeGridBuilder

CellDeselecting(String)

Triggers before the selected cell is deselecting.

Declaration
public TreeGridBuilder CellDeselecting(string cellDeselecting)
Parameters
Type Name Description
System.String cellDeselecting
Returns
Type Description
TreeGridBuilder

CellEdit(String)

Triggers when the cell is being edited.

Declaration
public TreeGridBuilder CellEdit(string cellEdit)
Parameters
Type Name Description
System.String cellEdit
Returns
Type Description
TreeGridBuilder

CellSave(String)

Triggers when cell is saved.

Declaration
public TreeGridBuilder CellSave(string cellSave)
Parameters
Type Name Description
System.String cellSave
Returns
Type Description
TreeGridBuilder

CellSaved(String)

Triggers when cell is saved.

Declaration
public TreeGridBuilder CellSaved(string cellSaved)
Parameters
Type Name Description
System.String cellSaved
Returns
Type Description
TreeGridBuilder

CellSelected(String)

Triggers after a cell is selected.

Declaration
public TreeGridBuilder CellSelected(string cellSelected)
Parameters
Type Name Description
System.String cellSelected
Returns
Type Description
TreeGridBuilder

CellSelecting(String)

Triggers before any cell selection occurs.

Declaration
public TreeGridBuilder CellSelecting(string cellSelecting)
Parameters
Type Name Description
System.String cellSelecting
Returns
Type Description
TreeGridBuilder

CheckboxChange(String)

Triggers when the check box state change in checkbox column.

Declaration
public TreeGridBuilder CheckboxChange(string checkboxChange)
Parameters
Type Name Description
System.String checkboxChange
Returns
Type Description
TreeGridBuilder

ChildMapping(String)

Specifies the mapping property path for child records in data source {% codeBlock src='treegrid/childMapping/index.md' %}{% endcodeBlock %}

Declaration
public TreeGridBuilder ChildMapping(string childMapping)
Parameters
Type Name Description
System.String childMapping
Returns
Type Description
TreeGridBuilder

ClipMode(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 TreeGridBuilder ClipMode(ClipMode clipMode)
Parameters
Type Name Description
ClipMode clipMode
Returns
Type Description
TreeGridBuilder

Collapsed(String)

Triggers after the record is collapsed.

Declaration
public TreeGridBuilder Collapsed(string collapsed)
Parameters
Type Name Description
System.String collapsed
Returns
Type Description
TreeGridBuilder

Collapsing(String)

Triggers while collapsing the TreeGrid record

Declaration
public TreeGridBuilder Collapsing(string collapsing)
Parameters
Type Name Description
System.String collapsing
Returns
Type Description
TreeGridBuilder

ColumnDrag(String)

Triggers when column header element is dragged (moved) continuously.

Declaration
public TreeGridBuilder ColumnDrag(string columnDrag)
Parameters
Type Name Description
System.String columnDrag
Returns
Type Description
TreeGridBuilder

ColumnDragStart(String)

Triggers when column header element drag (move) starts.

Declaration
public TreeGridBuilder ColumnDragStart(string columnDragStart)
Parameters
Type Name Description
System.String columnDragStart
Returns
Type Description
TreeGridBuilder

ColumnDrop(String)

Triggers when a column header element is dropped on the target column.

Declaration
public TreeGridBuilder ColumnDrop(string columnDrop)
Parameters
Type Name Description
System.String columnDrop
Returns
Type Description
TreeGridBuilder

ColumnMenuClick(String)

Triggers when click on column menu.

Declaration
public TreeGridBuilder ColumnMenuClick(string columnMenuClick)
Parameters
Type Name Description
System.String columnMenuClick
Returns
Type Description
TreeGridBuilder

ColumnMenuItems(Object)

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 TreeGridBuilder ColumnMenuItems(object columnMenuItems)
Parameters
Type Name Description
System.Object columnMenuItems
Returns
Type Description
TreeGridBuilder

ColumnMenuOpen(String)

Triggers before column menu opens.

Declaration
public TreeGridBuilder ColumnMenuOpen(string columnMenuOpen)
Parameters
Type Name Description
System.String columnMenuOpen
Returns
Type Description
TreeGridBuilder

ColumnQueryMode(Object)

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 TreeGridBuilder ColumnQueryMode(object columnQueryMode)
Parameters
Type Name Description
System.Object columnQueryMode
Returns
Type Description
TreeGridBuilder

Columns(Action<TreeGridColumnBuilder>)

Declaration
public TreeGridBuilder Columns(Action<TreeGridColumnBuilder> columns)
Parameters
Type Name Description
System.Action<TreeGridColumnBuilder> columns
Returns
Type Description
TreeGridBuilder

Columns(List<TreeGridColumn>)

Defines the schema of dataSource. If the columns declaration is empty or undefined then the columns are automatically generated from data source. {% codeBlock src='treegrid/columns/index.md' %}{% endcodeBlock %}

Declaration
public TreeGridBuilder Columns(List<TreeGridColumn> columns)
Parameters
Type Name Description
System.Collections.Generic.List<TreeGridColumn> columns
Returns
Type Description
TreeGridBuilder

Columns(Object)

Defines the schema of dataSource. If the columns declaration is empty or undefined then the columns are automatically generated from data source. {% codeBlock src='treegrid/columns/index.md' %}{% endcodeBlock %}

Declaration
public TreeGridBuilder Columns(object columns)
Parameters
Type Name Description
System.Object columns
Returns
Type Description
TreeGridBuilder

Columns(String[])

Defines the schema of dataSource. If the columns declaration is empty or undefined then the columns are automatically generated from data source. {% codeBlock src='treegrid/columns/index.md' %}{% endcodeBlock %}

Declaration
public TreeGridBuilder Columns(string[] columns)
Parameters
Type Name Description
System.String[] columns
Returns
Type Description
TreeGridBuilder

ContextMenuClick(String)

Triggers when click on context menu.

Declaration
public TreeGridBuilder ContextMenuClick(string contextMenuClick)
Parameters
Type Name Description
System.String contextMenuClick
Returns
Type Description
TreeGridBuilder

ContextMenuItems(Object)

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 TreeGridBuilder ContextMenuItems(object contextMenuItems)
Parameters
Type Name Description
System.Object contextMenuItems
Returns
Type Description
TreeGridBuilder

ContextMenuOpen(String)

Triggers before context menu opens.

Declaration
public TreeGridBuilder ContextMenuOpen(string contextMenuOpen)
Parameters
Type Name Description
System.String contextMenuOpen
Returns
Type Description
TreeGridBuilder

CopyHierarchyMode(CopyHierarchyType)

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 TreeGridBuilder CopyHierarchyMode(CopyHierarchyType copyHierarchyMode)
Parameters
Type Name Description
CopyHierarchyType copyHierarchyMode
Returns
Type Description
TreeGridBuilder

Created(String)

Triggers when the component is created.

Declaration
public TreeGridBuilder Created(string created)
Parameters
Type Name Description
System.String created
Returns
Type Description
TreeGridBuilder

DataBound(String)

Triggers when data source is populated in the TreeGrid.

Declaration
public TreeGridBuilder DataBound(string dataBound)
Parameters
Type Name Description
System.String dataBound
Returns
Type Description
TreeGridBuilder

DataSource(Action<DataManagerBuilder>)

Declaration
public TreeGridBuilder DataSource(Action<DataManagerBuilder> dataSource)
Parameters
Type Name Description
System.Action<DataManagerBuilder> dataSource
Returns
Type Description
TreeGridBuilder

DataSource(Object)

It is used to render TreeGrid table rows. {% codeBlock src='treegrid/dataSource/index.md' %}{% endcodeBlock %}

Declaration
public TreeGridBuilder DataSource(object dataSource)
Parameters
Type Name Description
System.Object dataSource
Returns
Type Description
TreeGridBuilder

DataSourceChanged(String)

Triggers when the TreeGrid data is added, deleted and updated. Invoke the done method from the argument to start render after edit operation.

Declaration
public TreeGridBuilder DataSourceChanged(string dataSourceChanged)
Parameters
Type Name Description
System.String dataSourceChanged
Returns
Type Description
TreeGridBuilder

DataStateChange(String)

Triggers when the TreeGrid actions such as Sorting, Paging etc., are done. In this event,the current view data and total record count should be assigned to the dataSource based on the action performed.

Declaration
public TreeGridBuilder DataStateChange(string dataStateChange)
Parameters
Type Name Description
System.String dataStateChange
Returns
Type Description
TreeGridBuilder

DetailDataBound(String)

Triggers after detail row expands.

This event triggers at initial expand.

Declaration
public TreeGridBuilder DetailDataBound(string detailDataBound)
Parameters
Type Name Description
System.String detailDataBound
Returns
Type Description
TreeGridBuilder

DetailTemplate(String)

The detail template allows you to show or hide additional information about a particular row.

Declaration
public TreeGridBuilder DetailTemplate(string detailTemplate)
Parameters
Type Name Description
System.String detailTemplate
Returns
Type Description
TreeGridBuilder

EditSettings(TreeGridEditSettings)

Configures the edit settings.

Declaration
public TreeGridBuilder EditSettings(TreeGridEditSettings editSettings)
Parameters
Type Name Description
TreeGridEditSettings editSettings
Returns
Type Description
TreeGridBuilder

EditSettings(Action<TreeGridEditSettingsBuilder>)

Declaration
public TreeGridBuilder EditSettings(Action<TreeGridEditSettingsBuilder> editSettings)
Parameters
Type Name Description
System.Action<TreeGridEditSettingsBuilder> editSettings
Returns
Type Description
TreeGridBuilder

EnableAdaptiveUI(Boolean)

If enableAdaptiveUI is set to true, the pop-up UI will become adaptive to small screens, and be used for filtering and other features.

Declaration
public TreeGridBuilder EnableAdaptiveUI(bool enableAdaptiveUI = true)
Parameters
Type Name Description
System.Boolean enableAdaptiveUI
Returns
Type Description
TreeGridBuilder

EnableAltRow(Boolean)

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

Check the AltRow to customize the styles of alternative rows.

Declaration
public TreeGridBuilder EnableAltRow(bool enableAltRow = true)
Parameters
Type Name Description
System.Boolean enableAltRow
Returns
Type Description
TreeGridBuilder

EnableAutoFill(Boolean)

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 TreeGridBuilder EnableAutoFill(bool enableAutoFill = true)
Parameters
Type Name Description
System.Boolean enableAutoFill
Returns
Type Description
TreeGridBuilder

EnableCollapseAll(Boolean)

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

Declaration
public TreeGridBuilder EnableCollapseAll(bool enableCollapseAll = true)
Parameters
Type Name Description
System.Boolean enableCollapseAll
Returns
Type Description
TreeGridBuilder

EnableColumnVirtualization(Boolean)

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 TreeGridBuilder EnableColumnVirtualization(bool enableColumnVirtualization = true)
Parameters
Type Name Description
System.Boolean enableColumnVirtualization
Returns
Type Description
TreeGridBuilder

EnableHover(Boolean)

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

Declaration
public TreeGridBuilder EnableHover(bool enableHover = true)
Parameters
Type Name Description
System.Boolean enableHover
Returns
Type Description
TreeGridBuilder

EnableImmutableMode(Boolean)

If enableImmutableMode is set to true, the TreeGrid will reuse old rows if it exists in the new result instead of full refresh while performing the TreeGrid actions.

Declaration
public TreeGridBuilder EnableImmutableMode(bool enableImmutableMode = true)
Parameters
Type Name Description
System.Boolean enableImmutableMode
Returns
Type Description
TreeGridBuilder

EnableInfiniteScrolling(Boolean)

If enableInfiniteScrolling set to true, then the data will be loaded in TreeGrid when the scrollbar reaches the end. This helps to load large dataset in TreeGrid.

Declaration
public TreeGridBuilder EnableInfiniteScrolling(bool enableInfiniteScrolling = true)
Parameters
Type Name Description
System.Boolean enableInfiniteScrolling
Returns
Type Description
TreeGridBuilder

EnablePersistence(Boolean)

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

Declaration
public TreeGridBuilder EnablePersistence(bool enablePersistence = true)
Parameters
Type Name Description
System.Boolean enablePersistence
Returns
Type Description
TreeGridBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration
public TreeGridBuilder EnableRtl(bool enableRtl = true)
Parameters
Type Name Description
System.Boolean enableRtl
Returns
Type Description
TreeGridBuilder

EnableVirtualization(Boolean)

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

Declaration
public TreeGridBuilder EnableVirtualization(bool enableVirtualization = true)
Parameters
Type Name Description
System.Boolean enableVirtualization
Returns
Type Description
TreeGridBuilder

EnableVirtualMaskRow(Boolean)

Specifies whether to display shimmer effect during scrolling action in virtual scrolling feature. If disabled, spinner is shown instead of shimmer effect.

Declaration
public TreeGridBuilder EnableVirtualMaskRow(bool enableVirtualMaskRow = true)
Parameters
Type Name Description
System.Boolean enableVirtualMaskRow
Returns
Type Description
TreeGridBuilder

ExcelExportComplete(String)

Triggers after TreeGrid data is exported to Excel file.

Declaration
public TreeGridBuilder ExcelExportComplete(string excelExportComplete)
Parameters
Type Name Description
System.String excelExportComplete
Returns
Type Description
TreeGridBuilder

ExcelHeaderQueryCellInfo(String)

Triggers before exporting each header cell to Excel file. You can also customize the Excel cells.

Declaration
public TreeGridBuilder ExcelHeaderQueryCellInfo(string excelHeaderQueryCellInfo)
Parameters
Type Name Description
System.String excelHeaderQueryCellInfo
Returns
Type Description
TreeGridBuilder

ExcelQueryCellInfo(String)

Triggers before exporting each cell to Excel file. You can also customize the Excel cells.

Declaration
public TreeGridBuilder ExcelQueryCellInfo(string excelQueryCellInfo)
Parameters
Type Name Description
System.String excelQueryCellInfo
Returns
Type Description
TreeGridBuilder

Expanded(String)

Triggers after the record is expanded

Declaration
public TreeGridBuilder Expanded(string expanded)
Parameters
Type Name Description
System.String expanded
Returns
Type Description
TreeGridBuilder

Expanding(String)

Triggers while expanding the TreeGrid record

Declaration
public TreeGridBuilder Expanding(string expanding)
Parameters
Type Name Description
System.String expanding
Returns
Type Description
TreeGridBuilder

ExpandStateMapping(String)

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

Declaration
public TreeGridBuilder ExpandStateMapping(string expandStateMapping)
Parameters
Type Name Description
System.String expandStateMapping
Returns
Type Description
TreeGridBuilder

FilterSettings(TreeGridFilterSettings)

Configures the filter settings of the TreeGrid.

Declaration
public TreeGridBuilder FilterSettings(TreeGridFilterSettings filterSettings)
Parameters
Type Name Description
TreeGridFilterSettings filterSettings
Returns
Type Description
TreeGridBuilder

FilterSettings(Action<TreeGridFilterSettingsBuilder>)

Declaration
public TreeGridBuilder FilterSettings(Action<TreeGridFilterSettingsBuilder> filterSettings)
Parameters
Type Name Description
System.Action<TreeGridFilterSettingsBuilder> filterSettings
Returns
Type Description
TreeGridBuilder

FrozenColumns(Double)

Gets or sets the number of frozen columns.

Declaration
public TreeGridBuilder FrozenColumns(double frozenColumns)
Parameters
Type Name Description
System.Double frozenColumns
Returns
Type Description
TreeGridBuilder

FrozenRows(Double)

Gets or sets the number of frozen rows.

Declaration
public TreeGridBuilder FrozenRows(double frozenRows)
Parameters
Type Name Description
System.Double frozenRows
Returns
Type Description
TreeGridBuilder

GridLines(GridLine)

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 TreeGridBuilder GridLines(GridLine gridLines)
Parameters
Type Name Description
GridLine gridLines
Returns
Type Description
TreeGridBuilder

HasChildMapping(String)

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

Declaration
public TreeGridBuilder HasChildMapping(string hasChildMapping)
Parameters
Type Name Description
System.String hasChildMapping
Returns
Type Description
TreeGridBuilder

HeaderCellInfo(String)

Triggered for stacked header.

Declaration
public TreeGridBuilder HeaderCellInfo(string headerCellInfo)
Parameters
Type Name Description
System.String headerCellInfo
Returns
Type Description
TreeGridBuilder

Height(Double)

Defines the scrollable height of the TreeGrid content.

Declaration
public TreeGridBuilder Height(double height)
Parameters
Type Name Description
System.Double height
Returns
Type Description
TreeGridBuilder

Height(String)

Defines the scrollable height of the TreeGrid content.

Declaration
public TreeGridBuilder Height(string height)
Parameters
Type Name Description
System.String height
Returns
Type Description
TreeGridBuilder

HtmlAttributes(Object)

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration
public TreeGridBuilder HtmlAttributes(object htmlAttributes)
Parameters
Type Name Description
System.Object htmlAttributes
Returns
Type Description
TreeGridBuilder

IdMapping(String)

Specifies the name of the field in the dataSource, which contains the id of that row. {% codeBlock src='treegrid/idMapping/index.md' %}{% endcodeBlock %}

Declaration
public TreeGridBuilder IdMapping(string idMapping)
Parameters
Type Name Description
System.String idMapping
Returns
Type Description
TreeGridBuilder

InfiniteScrollSettings(TreeGridInfiniteScrollSettings)

Configures the infinite scroll settings.

Declaration
public TreeGridBuilder InfiniteScrollSettings(TreeGridInfiniteScrollSettings infiniteScrollSettings)
Parameters
Type Name Description
TreeGridInfiniteScrollSettings infiniteScrollSettings
Returns
Type Description
TreeGridBuilder

InfiniteScrollSettings(Action<TreeGridInfiniteScrollSettingsBuilder>)

Declaration
public TreeGridBuilder InfiniteScrollSettings(Action<TreeGridInfiniteScrollSettingsBuilder> infiniteScrollSettings)
Parameters
Type Name Description
System.Action<TreeGridInfiniteScrollSettingsBuilder> infiniteScrollSettings
Returns
Type Description
TreeGridBuilder

Load(String)

This event allows customization of TreeGrid properties before rendering.

Declaration
public TreeGridBuilder Load(string load)
Parameters
Type Name Description
System.String load
Returns
Type Description
TreeGridBuilder

LoadChildOnDemand(Boolean)

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

Declaration
public TreeGridBuilder LoadChildOnDemand(bool loadChildOnDemand = true)
Parameters
Type Name Description
System.Boolean loadChildOnDemand
Returns
Type Description
TreeGridBuilder

LoadingIndicator(TreeGridLoadingIndicator)

Configures the loading indicator of the Tree Grid. Specifies whether to display spinner or shimmer effect during the waiting time on any actions (paging, sorting, filtering, CRUD operations) performed in Tree Grid.

Declaration
public TreeGridBuilder LoadingIndicator(TreeGridLoadingIndicator loadingIndicator)
Parameters
Type Name Description
TreeGridLoadingIndicator loadingIndicator
Returns
Type Description
TreeGridBuilder

LoadingIndicator(Action<TreeGridLoadingIndicatorBuilder>)

Declaration
public TreeGridBuilder LoadingIndicator(Action<TreeGridLoadingIndicatorBuilder> loadingIndicator)
Parameters
Type Name Description
System.Action<TreeGridLoadingIndicatorBuilder> loadingIndicator
Returns
Type Description
TreeGridBuilder

Locale(String)

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration
public TreeGridBuilder Locale(string locale)
Parameters
Type Name Description
System.String locale
Returns
Type Description
TreeGridBuilder

PageSettings(TreeGridPageSettings)

Configures the pager in the TreeGrid.

Declaration
public TreeGridBuilder PageSettings(TreeGridPageSettings pageSettings)
Parameters
Type Name Description
TreeGridPageSettings pageSettings
Returns
Type Description
TreeGridBuilder

PageSettings(Action<TreeGridPageSettingsBuilder>)

Declaration
public TreeGridBuilder PageSettings(Action<TreeGridPageSettingsBuilder> pageSettings)
Parameters
Type Name Description
System.Action<TreeGridPageSettingsBuilder> pageSettings
Returns
Type Description
TreeGridBuilder

ParentIdMapping(String)

Specifies the name of the field in the dataSource, which contains the parent’s id {% codeBlock src='treegrid/parentIdMapping/index.md' %}{% endcodeBlock %}

Declaration
public TreeGridBuilder ParentIdMapping(string parentIdMapping)
Parameters
Type Name Description
System.String parentIdMapping
Returns
Type Description
TreeGridBuilder

PdfExportComplete(String)

Triggers after TreeGrid data is exported to PDF document.

Declaration
public TreeGridBuilder PdfExportComplete(string pdfExportComplete)
Parameters
Type Name Description
System.String pdfExportComplete
Returns
Type Description
TreeGridBuilder

PdfHeaderQueryCellInfo(String)

Triggers before exporting each header cell to PDF document. You can also customize the PDF cells.

Declaration
public TreeGridBuilder PdfHeaderQueryCellInfo(string pdfHeaderQueryCellInfo)
Parameters
Type Name Description
System.String pdfHeaderQueryCellInfo
Returns
Type Description
TreeGridBuilder

PdfQueryCellInfo(String)

Triggers before exporting each cell to PDF document. You can also customize the PDF cells.

Declaration
public TreeGridBuilder PdfQueryCellInfo(string pdfQueryCellInfo)
Parameters
Type Name Description
System.String pdfQueryCellInfo
Returns
Type Description
TreeGridBuilder

PrintComplete(String)

Triggers after print action is completed.

Declaration
public TreeGridBuilder PrintComplete(string printComplete)
Parameters
Type Name Description
System.String printComplete
Returns
Type Description
TreeGridBuilder

PrintMode(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 TreeGridBuilder PrintMode(PrintMode printMode)
Parameters
Type Name Description
PrintMode printMode
Returns
Type Description
TreeGridBuilder

Query(String)

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

Declaration
public TreeGridBuilder Query(string query)
Parameters
Type Name Description
System.String query
Returns
Type Description
TreeGridBuilder

QueryCellInfo(String)

Triggered every time a request is made to access cell information, element, or data. This will be triggered before the cell element is appended to the TreeGrid element.

Declaration
public TreeGridBuilder QueryCellInfo(string queryCellInfo)
Parameters
Type Name Description
System.String queryCellInfo
Returns
Type Description
TreeGridBuilder

RecordDoubleClick(String)

Triggers when record is double clicked.

Declaration
public TreeGridBuilder RecordDoubleClick(string recordDoubleClick)
Parameters
Type Name Description
System.String recordDoubleClick
Returns
Type Description
TreeGridBuilder

Render()

Declaration
public HtmlString Render()
Returns
Type Description
System.Web.HtmlString

ResizeStart(String)

Triggers when column resize starts.

Declaration
public TreeGridBuilder ResizeStart(string resizeStart)
Parameters
Type Name Description
System.String resizeStart
Returns
Type Description
TreeGridBuilder

ResizeStop(String)

Triggers when column resize ends.

Declaration
public TreeGridBuilder ResizeStop(string resizeStop)
Parameters
Type Name Description
System.String resizeStop
Returns
Type Description
TreeGridBuilder

Resizing(String)

Triggers on column resizing.

Declaration
public TreeGridBuilder Resizing(string resizing)
Parameters
Type Name Description
System.String resizing
Returns
Type Description
TreeGridBuilder

RowDataBound(String)

Triggered every time a request is made to access row information, element, or data. This will be triggered before the row element is appended to the TreeGrid element.

Declaration
public TreeGridBuilder RowDataBound(string rowDataBound)
Parameters
Type Name Description
System.String rowDataBound
Returns
Type Description
TreeGridBuilder

RowDeselected(String)

Triggers when a selected row is deselected.

Declaration
public TreeGridBuilder RowDeselected(string rowDeselected)
Parameters
Type Name Description
System.String rowDeselected
Returns
Type Description
TreeGridBuilder

RowDeselecting(String)

Triggers before deselecting the selected row.

Declaration
public TreeGridBuilder RowDeselecting(string rowDeselecting)
Parameters
Type Name Description
System.String rowDeselecting
Returns
Type Description
TreeGridBuilder

RowDrag(String)

Triggers when row elements are dragged (moved) continuously.

Declaration
public TreeGridBuilder RowDrag(string rowDrag)
Parameters
Type Name Description
System.String rowDrag
Returns
Type Description
TreeGridBuilder

RowDragStart(String)

Triggers when row element’s drag(move) starts.

Declaration
public TreeGridBuilder RowDragStart(string rowDragStart)
Parameters
Type Name Description
System.String rowDragStart
Returns
Type Description
TreeGridBuilder

RowDragStartHelper(String)

Triggers when row element’s before drag(move).

Declaration
public TreeGridBuilder RowDragStartHelper(string rowDragStartHelper)
Parameters
Type Name Description
System.String rowDragStartHelper
Returns
Type Description
TreeGridBuilder

RowDrop(String)

Triggers when row elements are dropped on the target row.

Declaration
public TreeGridBuilder RowDrop(string rowDrop)
Parameters
Type Name Description
System.String rowDrop
Returns
Type Description
TreeGridBuilder

RowDropSettings(TreeGridRowDropSettings)

Configures the row drop settings of the TreeGrid.

Declaration
public TreeGridBuilder RowDropSettings(TreeGridRowDropSettings rowDropSettings)
Parameters
Type Name Description
TreeGridRowDropSettings rowDropSettings
Returns
Type Description
TreeGridBuilder

RowDropSettings(Action<TreeGridRowDropSettingsBuilder>)

Declaration
public TreeGridBuilder RowDropSettings(Action<TreeGridRowDropSettingsBuilder> rowDropSettings)
Parameters
Type Name Description
System.Action<TreeGridRowDropSettingsBuilder> rowDropSettings
Returns
Type Description
TreeGridBuilder

RowHeight(Double)

Defines the height of TreeGrid rows.

Declaration
public TreeGridBuilder RowHeight(double rowHeight)
Parameters
Type Name Description
System.Double rowHeight
Returns
Type Description
TreeGridBuilder

RowSelected(String)

Triggers after a row is selected.

Declaration
public TreeGridBuilder RowSelected(string rowSelected)
Parameters
Type Name Description
System.String rowSelected
Returns
Type Description
TreeGridBuilder

RowSelecting(String)

Triggers before row selection occurs.

Declaration
public TreeGridBuilder RowSelecting(string rowSelecting)
Parameters
Type Name Description
System.String rowSelecting
Returns
Type Description
TreeGridBuilder

RowTemplate(String)

The row template that renders customized rows from the given template. By default, TreeGrid renders a table row for every data source item.

It accepts either template string or HTML element ID. The row template must be a table row.

Declaration
public TreeGridBuilder RowTemplate(string rowTemplate)
Parameters
Type Name Description
System.String rowTemplate
Returns
Type Description
TreeGridBuilder

SearchSettings(TreeGridSearchSettings)

Configures the search settings of the TreeGrid.

Declaration
public TreeGridBuilder SearchSettings(TreeGridSearchSettings searchSettings)
Parameters
Type Name Description
TreeGridSearchSettings searchSettings
Returns
Type Description
TreeGridBuilder

SearchSettings(Action<TreeGridSearchSettingsBuilder>)

Declaration
public TreeGridBuilder SearchSettings(Action<TreeGridSearchSettingsBuilder> searchSettings)
Parameters
Type Name Description
System.Action<TreeGridSearchSettingsBuilder> searchSettings
Returns
Type Description
TreeGridBuilder

SelectedRowIndex(Double)

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

Declaration
public TreeGridBuilder SelectedRowIndex(double selectedRowIndex)
Parameters
Type Name Description
System.Double selectedRowIndex
Returns
Type Description
TreeGridBuilder

SelectionSettings(TreeGridSelectionSettings)

Configures the selection settings.

Declaration
public TreeGridBuilder SelectionSettings(TreeGridSelectionSettings selectionSettings)
Parameters
Type Name Description
TreeGridSelectionSettings selectionSettings
Returns
Type Description
TreeGridBuilder

SelectionSettings(Action<TreeGridSelectionSettingsBuilder>)

Declaration
public TreeGridBuilder SelectionSettings(Action<TreeGridSelectionSettingsBuilder> selectionSettings)
Parameters
Type Name Description
System.Action<TreeGridSelectionSettingsBuilder> selectionSettings
Returns
Type Description
TreeGridBuilder

ShowColumnChooser(Boolean)

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

Declaration
public TreeGridBuilder ShowColumnChooser(bool showColumnChooser = true)
Parameters
Type Name Description
System.Boolean showColumnChooser
Returns
Type Description
TreeGridBuilder

ShowColumnMenu(Boolean)

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

Declaration
public TreeGridBuilder ShowColumnMenu(bool showColumnMenu = true)
Parameters
Type Name Description
System.Boolean showColumnMenu
Returns
Type Description
TreeGridBuilder

SortSettings(TreeGridSortSettings)

Configures the sort settings of the TreeGrid.

Declaration
public TreeGridBuilder SortSettings(TreeGridSortSettings sortSettings)
Parameters
Type Name Description
TreeGridSortSettings sortSettings
Returns
Type Description
TreeGridBuilder

SortSettings(Action<TreeGridSortSettingsBuilder>)

Declaration
public TreeGridBuilder SortSettings(Action<TreeGridSortSettingsBuilder> sortSettings)
Parameters
Type Name Description
System.Action<TreeGridSortSettingsBuilder> sortSettings
Returns
Type Description
TreeGridBuilder

TextWrapSettings(TreeGridTextWrapSettings)

Configures the text wrap in the TreeGrid.

Declaration
public TreeGridBuilder TextWrapSettings(TreeGridTextWrapSettings textWrapSettings)
Parameters
Type Name Description
TreeGridTextWrapSettings textWrapSettings
Returns
Type Description
TreeGridBuilder

TextWrapSettings(Action<TreeGridTextWrapSettingsBuilder>)

Declaration
public TreeGridBuilder TextWrapSettings(Action<TreeGridTextWrapSettingsBuilder> textWrapSettings)
Parameters
Type Name Description
System.Action<TreeGridTextWrapSettingsBuilder> textWrapSettings
Returns
Type Description
TreeGridBuilder

Toolbar(Object)

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 TreeGridBuilder Toolbar(object toolbar)
Parameters
Type Name Description
System.Object toolbar
Returns
Type Description
TreeGridBuilder

ToolbarClick(String)

Triggers when toolbar item is clicked.

Declaration
public TreeGridBuilder ToolbarClick(string toolbarClick)
Parameters
Type Name Description
System.String toolbarClick
Returns
Type Description
TreeGridBuilder

TreeColumnIndex(Double)

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

Declaration
public TreeGridBuilder TreeColumnIndex(double treeColumnIndex)
Parameters
Type Name Description
System.Double treeColumnIndex
Returns
Type Description
TreeGridBuilder

Width(Double)

Defines the TreeGrid width.

Declaration
public TreeGridBuilder Width(double width)
Parameters
Type Name Description
System.Double width
Returns
Type Description
TreeGridBuilder

Width(String)

Defines the TreeGrid width.

Declaration
public TreeGridBuilder Width(string width)
Parameters
Type Name Description
System.String width
Returns
Type Description
TreeGridBuilder