Back to Devexpress

DxTreeList Properties

blazor-devexpress-dot-blazor-dot-dxtreelist-dot-underscore-properties.md

latest12.4 KB
Original Source

DxTreeList Properties

A component that displays hierarchical data in a tabular format and allows users to edit, sort, filter, and otherwise shape data.

NameDescription
AllowColumnReorderSpecifies whether users can reorder columns.
AllowDragRowsSpecifies whether users can start the row drag operation.
AllowedDropTargetSpecifies allowed drag-and-drop targets.
AllowSelectRowByClickSpecifies whether users can select and deselect rows by mouse clicks, tap gestures, and keyboard shortcuts.
AllowSortSpecifies whether users can sort treelist data.
AttributesSpecifies a collection of standard HTML attributes applied to the TreeList.
AutoExpandAllNodesSpecifies whether to automatically expand all nodes when the TreeList loads data.
ChildrenFieldNameSpecifies the field name that stores the node’s child data items.
ColumnCaptionAlignmentSpecifies the alignment of all column captions.
ColumnFooterTemplateSpecifies a common template used to display all footer cells in the TreeList.
ColumnHeaderCaptionTemplateSpecifies a common template used to display captions of all column headers in the TreeList.
ColumnResizeModeSpecifies whether and how users can resize TreeList columns.
ColumnsAllows you to add TreeList columns.
ContextMenusSpecifies available context menus.
CssClassAssigns a CSS class to the TreeList.
CustomValidatorsAllows you to declare custom validator components.
DataSpecifies a data source.
DataColumnCellDisplayTemplateSpecifies a common template used to display all data column cells in the TreeList.
DataColumnCellEditTemplateAllows you to replace automatically generated editors with custom content in all edit cells displayed for data columns.
DataColumnFilterMenuTemplateSpecifies a common template used to display all column filter menus.
DataColumnFilterRowCellTemplateAllows you to replace automatically generated editors with custom content in all filter row cells displayed for data columns.
DragHintTextTemplateSpecifies the template for the drag hint.
DropTargetModeSpecifies the drop position behavior. Applicable only to drag and drop operations initiated externally.
EditFormButtonsVisibleSpecifies whether the edit form contains predefined Save and Cancel buttons.
EditFormTemplateSpecifies the template used to display the edit form.
EditModeSpecifies how users can edit TreeList data.
EditNewRootRowPositionSpecifies the position of UI elements used to create new root nodes.
EditOnKeyPressIn EditCell mode, specifies whether cell editing starts once a user begins typing a new value.
EmptyDataAreaTemplateSpecifies the template used to display an empty data area.
EnterKeyDirectionIn EditCell mode, specifies where focus moves after a user presses Enter.
FilterBuilderTemplateSpecifies the template for the filter builder.
FilterMenuButtonDisplayModeSpecifies when the TreeList displays filter menu buttons in column headers.
FilterPanelDisplayModeSpecifies the filter panel visibility.
FilterTreeModeSpecifies how the TreeList component displays filtered nodes.
FocusedRowEnabledSpecifies whether row focus is enabled.
FooterDisplayModeSpecifies when to display the footer in the TreeList.
HasChildrenFieldNameSpecifies the field name that defines whether a node has children.
HighlightRowOnHoverSpecifies whether to highlight a data row when a user hovers the mouse pointer over it.
KeyFieldNameSpecifies the field name that contains unique identifiers for TreeList nodes.
PageIndexSpecifies the active page index.
PagerAutoHideNavButtonsSpecifies whether arrow navigation buttons are hidden when all numeric buttons are displayed in the pager.
PagerNavigationModeSpecifies how users navigate between TreeList pages.
PagerPositionSpecifies the pager position.
PagerSwitchToInputBoxButtonCountSpecifies the total number of pages when the pager switches from numeric buttons to the input box in Auto mode.
PagerVisibleSpecifies whether the TreeList displays the pager.
PagerVisibleNumericButtonCountSpecifies the maximum number of numeric buttons displayed in the pager.
PageSizeSpecifies the maximum number of rows displayed on a page.
PageSizeSelectorAllRowsItemVisibleSpecifies whether the page size selector contains the All item.
PageSizeSelectorItemsSpecifies items available in the page size selector.
PageSizeSelectorVisibleSpecifies whether the TreeList displays the page size selector in the pager.
ParentKeyFieldNameSpecifies the field that links a node to its parent.
PopupEditFormCssClassAssigns a CSS class to the pop-up edit form.
PopupEditFormHeaderTextSpecifies text displayed in the pop-up edit form’s header.
RootValueSpecifies the value that root nodes contain in the field assigned to the ParentKeyFieldName property.
SearchBoxInputDelaySpecifies the delay between the last typed character in the search box and the search update.
SearchBoxNullTextSpecifies the prompt text displayed in the search box when it is empty.
SearchBoxTemplateSpecifies a template for the search box.
SearchTextSpecifies the text that the TreeList uses to filter and highlight data.
SearchTextParseModeSpecify how the TreeList searches for a match if the query contains multiple words.
SelectAllCheckboxModeSpecifies whether the Select All checkbox selects all rows on the current page or on all TreeList pages.
SelectedDataItemIn single selection mode, this property specifies the data item that corresponds to the selected TreeList row.
SelectedDataItemsIn multiple selection mode, this property specifies data items that correspond to selected TreeList rows.
SelectionModeSpecifies the selection mode.
ShowAllRowsSpecifies 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.
ShowFilterRowSpecifies whether the TreeList displays the filter row.
ShowSearchBoxSpecifies whether the TreeList displays the search box.
SizeModeSpecifies the size of TreeList elements (for instance, text size and row height) and other built-in components (for instance, pager and buttons).
SkeletonRowsEnabledSpecifies whether the TreeList displays skeletons while it loads data.
TextWrapEnabledSpecifies whether the TreeList wraps words or if it trims extra words and displays an ellipsis.
ToolbarTemplateSpecifies a template for a toolbar area.
TotalSummaryContains total summary items.
ValidationEnabledSpecifies whether the TreeList validates user input.
VirtualScrollingEnabledSpecifies whether virtual scrolling is enabled.
VirtualScrollingModeWhen VirtualScrollingEnabled is set to true, specifies whether the TreeList virtualizes rows, columns, or both.

See Also

DxTreeList Class

DxTreeList Members

DevExpress.Blazor Namespace