ITreeList Members

An interface that defines DxTreeList component API members (properties and methods).

Properties

Name	Description
AllowColumnReorder	Specifies whether users can reorder columns.
AllowDragRows	Specifies whether users can start the row drag operation.
AllowedDropTarget	Specifies allowed drag-and-drop targets.
AllowSelectRowByClick	Specifies whether users can select and deselect rows by mouse clicks.
AllowSort	Specifies whether users can sort grid data.
Attributes	Specifies a collection of standard HTML attributes applied to the TreeList.
AutoExpandAllNodes	Specifies whether to automatically expand all nodes when the TreeList loads data.
ChildrenFieldName	Specifies the field name that stores the node’s child data items.
ColumnCaptionAlignment	Specifies the alignment of all column captions.
ColumnFooterTemplate	Specifies a common template used to display all footer cells in the Treelist.
ColumnHeaderCaptionTemplate	Specifies a common template used to display captions of all column headers in the TreeList.
ColumnResizeMode	Specifies whether and how users can resize TreeList columns.
CssClass	Assigns a CSS class to the TreeList.
CustomValidators	Allows you to declare custom validator components.
Data	Specifies a data source.
DataColumnCellDisplayTemplate	Specifies a common template used to display all data column cells in the TreeList.
DataColumnCellEditTemplate	Allows you to replace automatically generated editors with custom content in all edit cells displayed for data columns.
DataColumnFilterMenuTemplate	Specifies a common template used to display all column filter menus.
DataColumnFilterRowCellTemplate	Allows you to replace automatically generated editors with custom content in all filter row cells displayed for data columns.
DragHintTextTemplate	Specifies the template for the drag hint.
DropTargetMode	Specifies the drop position behavior. Applicable only to drag and drop operations initiated externally.
EditFormButtonsVisible	Specifies whether the edit form contains predefined Save and Cancel buttons.
EditFormTemplate	Specifies the template used to display the edit form.
EditMode	Specifies how users can edit TreeList data.
EditNewRootRowPosition	Specifies the position of UI elements used to create new root nodes.
EmptyDataAreaTemplate	Specifies the template used to display an empty data area.
FilterMenuButtonDisplayMode	Specifies when the TreeList displays filter menu buttons in column headers.
FilterTreeMode	Specifies how the TreeList component displays filtered nodes.
FocusedRowEnabled	Specifies whether the row focus is enabled.
FooterDisplayMode	Specifies when to display the footer in the TreeList.
HasChildrenFieldName	Specifies the field name that defines whether a node has children.
HighlightRowOnHover	Specifies whether to highlight a data row when a user hovers the mouse pointer over it.
KeyFieldName	Specifies the field name that contains unique identifiers for TreeList nodes.
PageIndex	Specifies the active page index.
PagerAutoHideNavButtons	Specifies whether arrow navigation buttons are hidden when all numeric buttons are displayed in the pager.
PagerNavigationMode	Specifies how users navigate between TreeList pages.
PagerPosition	Specifies the pager position.
PagerSwitchToInputBoxButtonCount	Specifies the number of pages when the pager switches from numeric buttons to the input box in Auto mode.
PagerVisible	Specifies whether the TreeList displays the pager.
PagerVisibleNumericButtonCount	Specifies the maximum number of numeric buttons displayed in the pager.
PageSize	Specifies the maximum number of rows displayed on a page.
PageSizeSelectorAllRowsItemVisible	Specifies whether the page size selector contains the All item.
PageSizeSelectorItems	Specifies items available in the page size selector.
PageSizeSelectorVisible	Specifies whether the TreeList displays the page size selector in the pager.
ParentKeyFieldName	Specifies the field that links a node to its parent.
PopupEditFormCssClass	Assigns a CSS class to the pop-up edit form.
PopupEditFormHeaderText	Specifies text displayed in the pop-up edit form’s header.
RootValue	Specifies the value that root nodes contain in the field assigned to the ParentKeyFieldName property.
SelectAllCheckboxMode	Specifies whether the Select All checkbox selects all rows on the current page or on all treelist pages.
SelectedDataItem	In single selection mode, this property specifies the data item that corresponds to the selected TreeList row.
SelectedDataItems	In multiple selection mode, this property specifies data items that corresponds to selected TreeList rows.
SelectionMode	Specifies selection mode.
ShowAllRows	Specifies whether the TreeList displays all rows on one page.
ShowFilterRow	Specifies whether the TreeList displays the filter row.
SizeMode	Specifies the size of treelist elements (for instance, text size and row height) and other built-in components (for instance, pager and buttons).
SkeletonRowsEnabled	Specifies whether the TreeList displays skeleton rows while it loads data.
TextWrapEnabled	Specifies whether the TreeList wraps words or trims extra words and displays an ellipsis.
ToolbarTemplate	Specifies a template for a toolbar area.
ValidationEnabled	Specifies whether the TreeList validates user input.
VirtualScrollingEnabled	Specifies whether vertical virtual scrolling is enabled.

Methods

Name	Description
AutoFitColumnWidths()	Adjusts column width to content.
BeginUpdate()	Suspends TreeList updates caused by parameter changes and method calls until the EndUpdate() method is called.
CancelEditAsync()	Cancels row editing and discards changes.
ClearFilter()	Clears the filter applied to treelist data.
ClearSelection()	Clears selection.
ClearSort()	Clears sorting.
CollapseAll()	Collapses all rows in the TreeList component.
CollapseRow(Int32)	Collapses the row with the specified visible index.
DeselectAllAsync()	Deselects all rows in the treelist.
DeselectAllOnPage()	Deselects all rows on the current visible page.
DeselectDataItem(Object)	Deselects a row that corresponds to the specified data item.
DeselectDataItems(IEnumerable<Object>)	Deselects rows that correspond to the specified data items.
DeselectRow(Int32)	Unselects a row with the specified visible index.
DeselectRows(IEnumerable<Int32>)	Deselects rows with the specified visible indexes.
EndUpdate()	Resumes TreeList updates (when the BeginUpdate() method pauses updates) and re-renders the TreeList.
ExpandAll()	Expands all rows in the TreeList component.
ExpandRow(Int32)	Expands the row with the specified visible index.
ExportToCsvAsync(Stream, TreeListCsvExportOptions)	Exports TreeList data to a stream in CSV format.
ExportToCsvAsync(String, TreeListCsvExportOptions)	Exports TreeList data in CSV format and downloads the resulting file to the client machine.
ExportToXlsAsync(Stream, TreeListXlExportOptions)	Exports TreeList data in XLS format to a stream.
ExportToXlsAsync(String, TreeListXlExportOptions)	Exports TreeList data in XLS format and downloads the resulting file to the client machine.
ExportToXlsxAsync(Stream, TreeListXlExportOptions)	Exports TreeList data in XLSX format to a stream.
ExportToXlsxAsync(String, TreeListXlExportOptions)	Exports TreeList data in XLSX format and downloads the resulting file to the client machine.
FilterBy(String, TreeListFilterRowOperatorType, Object)	Filters treelist data by specified column value.
GetColumnEditSettings<T>(String)	Returns editor settings of the column bound to the specified data source field.
GetColumns()	Returns a collection of all treelist columns.
GetDataColumns()	Returns a data column collection.
GetDataItem(Int32)	Gets a data source item that is bound to the processed row.
GetDataItemValue(Object, String)	Returns the value of the specified field for the specified data item.
GetEditContext()	Returns the edit context.
GetFieldFilterCriteria(String)	Returns the filter criteria applied to the specified field of the bound data source.
GetFilterCriteria()	Returns the filter criteria applied to treelist data.
GetFocusedDataItem()	Returns a data item bound to the focused data row.
GetFocusedRowIndex()	Returns the visible index of the focused row.
GetPageCount()	Returns the total number of pages in the TreeList.
GetRowValue(Int32, String)	Returns the value of the data source field in the specified row.
GetSortedColumns()	Gets the collection of sorted columns.
GetStartRowVisibleIndex()	Gets the visible index of the first row on the current page.
GetTotalSummaryDisplayText(ITreeListSummaryItem)	Gets a total summary item’s display text.
GetTotalSummaryFormattedValue(ITreeListSummaryItem)	Gets a total summary item’s formatted value.
GetTotalSummaryItems()	Returns the collection of total summary. items.
GetTotalSummaryLabel(ITreeListSummaryItem)	Returns the name of a total summary‘s function name.
GetTotalSummaryValue(ITreeListSummaryItem)	Gets a total summary item’s value.
GetVisibleColumns()	Returns a collection of visible columns sorted based on their display order.
GetVisibleRowCount()	Returns the total number of visible rows in the treelist.
IsDataItemFocused(Object)	Returns whether the row bound to the specified data item is focused.
IsDataItemSelected(Object)	Returns whether the row that corresponds to the specified data item is selected.
IsEditing()	Returns whether the TreeList is being edited.
IsEditingNewRow()	Returns whether a new TreeList row is being edited.
IsEditingRow(Int32)	Returns whether the specified TreeList row is being edited.
IsRowExpanded(Int32)	Returns whether the row with the specified visible index is expanded.
IsRowFocused(Int32)	Returns whether the row with the specified visible index is focused.
IsRowSelected(Int32)	Returns whether the specified row is selected.
LoadLayout(TreeListPersistentLayout)	Restores the TreeList layout.
MakeRowVisible(Int32)	Makes the row with the specified visible index visible on screen.
RefreshSummary()	Refreshes all total summary values in the TreeList.
Reload()	Reloads TreeList data.
SaveChangesAsync()	Triggers validation and raises the EditModelSaving event if validation succeeds. The method immediately raises this event if validation is disabled.
SaveLayout()	Saves information about the TreeList layout.
SelectAllAsync(Boolean)	Selects or deselects all rows in the treelist.
SelectAllOnPage(Boolean)	Selects or deselects all rows on the current visible page.
SelectDataItem(Object, Boolean)	Selects or deselects a row that corresponds to the specified data item.
SelectDataItems(IEnumerable<Object>, Boolean)	Selects or deselects rows that correspond to the specified data items.
SelectRow(Int32, Boolean)	Selects or deselects a row with the specified visible index.
SelectRows(IEnumerable<Int32>, Boolean)	Selects or deselects rows with the specified visible indexes.
SetFieldFilterCriteria(String, CriteriaOperator)	Applies a filter to the specified data field.
SetFilterCriteria(CriteriaOperator)	Applies a filter to treelist data.
SetFocusedRowIndex(Int32)	Moves focus to the row with the specified visible index.
ShowColumnChooser()	Shows the column chooser in the center of the treelist.
ShowColumnChooser(DialogDisplayOptions)	Shows the column chooser and positions it based on specified display options.
ShowColumnChooser(String)	Shows the column chooser below the specified target element.
ShowRowDeleteConfirmation(Int32)	Displays the delete confirmation dialog for the specified row. If a user confirms the operation, the method raises the DataItemDeleting event.
SortBy(String, TreeListColumnSortOrder, Int32)	Sorts data by column values in the specified order, and specifies the sorted column’s index.
SortBy(String, TreeListColumnSortOrder)	Sorts data by column values in the specified order.
SortBy(String)	Sorts data by the specified column values.
StartEditNewRowAsync(Int32, String)	Starts editing a new child node of the row with the specified visible index.
StartEditNewRowAsync(String)	Starts editing a new root node.
StartEditRowAsync(Int32, String)	Starts editing the row with the specified visible index.
WaitForDataLoadAsync()	Returns a task that completes when pending asynchronous data load operations are completed.
WaitForRemoteSourceRowLoadAsync(Int32)	Returns a task that is completed when the specified row of an asynchronous remote data source is loaded.

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

ITreeList Members

Properties

Methods