ITreeList Properties
An interface that defines DxTreeList component API members (properties and methods).| 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. |
| EditOnKeyPress | In EditCell mode, specifies whether cell editing starts once a user begins typing a new value. |
| EmptyDataAreaTemplate | Specifies the template used to display an empty data area. |
| EnterKeyDirection | In EditCell mode, specifies where focus moves after a user presses Enter. |
| 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. |
| SearchBoxInputDelay | Specifies the delay between the last typed character in the search box and the search update. |
| SearchBoxNullText | Specifies the prompt text displayed in the search box when it is empty. |
| SearchBoxTemplate | Specifies a template for the search box. |
| SearchText | Specifies the text that the TreeList uses to filter and highlight data. |
| SearchTextParseMode | Specify how the TreeList searches for a match if the query contains multiple words. |
| 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. To avoid performance issues when the TreeList is bound to a large data source, use the VirtualScrollingEnabled property instead. |
| ShowFilterRow | Specifies whether the TreeList displays the filter row. |
| ShowSearchBox | Specifies whether the TreeList displays the search box. |
| 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. |
See Also