DxTreeList Members
#Constructors
Name | Description |
---|---|
Dx |
Initializes a new instance of the Dx |
#Properties
Name | Description |
---|---|
Allow |
Specifies whether users can reorder columns. |
Allow |
Specifies whether users can start the row drag operation. |
Allowed |
Specifies allowed drag-and-drop targets. |
Allow |
Specifies whether users can select and deselect rows by mouse clicks, tap gestures, and keyboard shortcuts. |
Allow |
Specifies whether users can sort treelist data. |
Attributes |
Specifies a collection of standard HTML attributes applied to the Tree |
Auto |
Specifies whether to automatically expand all nodes when the Tree |
Children |
Specifies the field name that stores the node’s child data items. |
Column |
Specifies the alignment of all column captions. |
Column |
Specifies a common template used to display all footer cells in the Tree |
Column |
Specifies a common template used to display captions of all column headers in the Tree |
Column |
Specifies whether and how users can resize Tree |
Columns |
Allows you to add Tree |
Css |
Assigns a CSS class to the Tree |
Custom |
Allows you to declare custom validator components. |
Data | Specifies a data source. |
Data |
Specifies a common template used to display all data column cells in the Tree |
Data |
Allows you to replace automatically generated editors with custom content in all edit cells displayed for data columns. |
Data |
Specifies a common template used to display all column filter menus. |
Data |
Allows you to replace automatically generated editors with custom content in all filter row cells displayed for data columns. |
Drag |
Specifies the template for the drag hint. |
Drop |
Specifies the drop position behavior. Applicable only to drag and drop operations initiated externally. |
Edit |
Specifies whether the edit form contains predefined Save and Cancel buttons. |
Edit |
Specifies the template used to display the edit form. |
Edit |
Specifies how users can edit Tree |
Edit |
Specifies the position of UI elements used to create new root nodes. |
Empty |
Specifies the template used to display an empty data area. |
Filter |
Specifies when the Tree |
Filter |
Specifies how the Tree |
Focused |
Specifies whether row focus is enabled. |
Footer |
Specifies when to display the footer in the Tree |
Has |
Specifies the field name that defines whether a node has children. |
Highlight |
Specifies whether to highlight a data row when a user hovers the mouse pointer over it. |
Key |
Specifies the field name that contains unique identifiers for Tree |
Page |
Specifies the active page index. |
Pager |
Specifies whether arrow navigation buttons are hidden when all numeric buttons are displayed in the pager. |
Pager |
Specifies how users navigate between Tree |
Pager |
Specifies the pager position. |
Pager |
Specifies the total number of pages when the pager switches from numeric buttons to the input box in Auto mode. |
Pager |
Specifies whether the Tree |
Pager |
Specifies the maximum number of numeric buttons displayed in the pager. |
Page |
Specifies the maximum number of rows displayed on a page. |
Page |
Specifies whether the page size selector contains the All item. |
Page |
Specifies items available in the page size selector. |
Page |
Specifies whether the Tree |
Parent |
Specifies the field that links a node to its parent. |
Popup |
Assigns a CSS class to the pop-up edit form. |
Popup |
Specifies text displayed in the pop-up edit form’s header. |
Root |
Specifies the value that root nodes contain in the field assigned to the Parent |
Select |
Specifies whether the Select All checkbox selects all rows on the current page or on all Tree |
Selected |
In single selection mode, this property specifies the data item that corresponds to the selected Tree |
Selected |
In multiple selection mode, this property specifies data items that correspond to selected Tree |
Selection |
Specifies the selection mode. |
Show |
Specifies whether the Tree |
Show |
Specifies whether the Tree |
Size |
Specifies the size of Tree |
Skeleton |
Specifies whether the Tree |
Text |
Specifies whether the Tree |
Toolbar |
Specifies a template for a toolbar area. |
Total |
Contains total summary items. |
Validation |
Specifies whether the Tree |
Virtual |
Specifies whether vertical virtual scrolling is enabled. |
#Methods
Name | Description |
---|---|
Auto |
Adjusts column width to content. |
Begin |
Suspends Tree |
Cancel |
Cancels row editing and discards changes. |
Clear |
Clears the filter applied to Tree |
Clear |
Clears selection. |
Clear |
Clears sorting. |
Collapse |
Collapses all rows in the Tree |
Collapse |
Collapses the row with the specified visible index. |
Deselect |
Deselects all rows in the Tree |
Deselect |
Deselects all rows on the currently visible page except for child rows of collapsed items. |
Deselect |
Deselects a row that corresponds to the specified data item. |
Deselect |
Deselects rows that correspond to the specified data items. |
Deselect |
Deselects a row with the specified visible index. |
Deselect |
Deselects rows with the specified visible indexes. |
End |
Resumes Tree |
Equals |
Determines whether the specified object instances are considered equal. Inherited from Object. |
Equals |
Determines whether the specified object is equal to the current object. Inherited from Object. |
Expand |
Expands all rows in the Tree |
Expand |
Expands the row with the specified visible index. |
Export |
Exports Tree |
Export |
Exports Tree |
Export |
Exports Tree |
Export |
Exports Tree |
Export |
Exports Tree |
Export |
Exports Tree |
Filter |
Filters Tree |
Get |
Returns editor settings of the column bound to the specified data source field. |
Get |
Returns a collection of all treelist columns. |
Get |
Returns a data column collection. |
Get |
Returns a data source item bound to the row with the specified visible index. |
Get |
Returns the value of the specified field for the specified data item. |
Get |
Returns the edit context. |
Get |
Returns the filter criteria applied to the specified field of the bound data source. |
Get |
Returns the filter criteria applied to Tree |
Get |
Returns a data item bound to the focused data row. |
Get |
Returns the visible index of the focused row. |
Get |
Serves as the default hash function. Inherited from Object. |
Get |
Returns the total number of pages in the Tree |
Get |
Returns the value of the data source field in the specified row. |
Get |
Gets the collection of sorted columns. |
Get |
Gets the visible index of the first row on the current page. |
Get |
Gets a total summary item’s display text. |
Get |
Gets a total summary item’s formatted value. |
Get |
Returns the collection of total summary items. |
Get |
Returns the name of a total summary‘s function name. |
Get |
Gets a total summary item’s value. |
Get |
Gets the Type of the current instance. Inherited from Object. |
Get |
Returns a collection of visible columns sorted based on their display order. |
Get |
Returns the total number of visible rows in the Tree |
Is |
Returns whether the row bound to the specified data item is focused. |
Is |
Returns whether the row that corresponds to the specified data item is selected. |
Is |
Returns whether the Tree |
Is |
Returns whether a new Tree |
Is |
Returns whether the specified Tree |
Is |
Returns whether the row with the specified visible index is expanded. |
Is |
Returns whether the row with the specified visible index is focused. |
Is |
Returns whether the specified row is selected. |
Load |
Restores the Tree |
Make |
Makes the row with the specified visible index visible on screen. |
Memberwise |
Creates a shallow copy of the current Object. Inherited from Object. |
Reference |
Determines whether the specified Object instances are the same instance. Inherited from Object. |
Refresh |
Refreshes all total summary values in the Tree |
Reload() |
Reloads Tree |
Save |
Triggers validation and raises the Edit |
Save |
Saves information about the Tree |
Select |
Selects or deselects all rows in the Tree |
Select |
Selects or deselects all rows on the currently visible page except for child rows of collapsed items. |
Select |
Selects or deselects a row that corresponds to the specified data item. |
Select |
Selects or deselects rows that correspond to the specified data items. |
Select |
Selects or deselects a row with the specified visible index. |
Select |
Selects or deselects rows with the specified visible indexes. |
Set |
Applies a filter to the specified data field. |
Set |
Applies a filter to Tree |
Set |
Moves focus to the row with the specified visible index. |
Show |
Shows the column chooser in the center of the treelist. |
Show |
Shows the column chooser and positions it based on specified display options. |
Show |
Shows the column chooser below the specified target element. |
Show |
Displays the delete confirmation dialog for the specified row. If a user confirms the operation, the method raises the Data |
Sort |
Sorts data by column values in the specified order and specifies the sorted column’s index. |
Sort |
Sorts data by column values in the specified order. |
Sort |
Sorts data by the specified column values. |
Start |
Starts editing a new child node of the row with the specified visible index. |
Start |
Starts editing a new root node. |
Start |
Starts editing the row with the specified visible index. |
To |
Returns a string that represents the current object. Inherited from Object. |
Wait |
Returns a task that completes when pending asynchronous data load operations are completed. |
Wait |
Returns a task that is completed when the specified row of a remote data source is loaded. |
#Events
Name | Description |
---|---|
Children |
Allows you to populate a node with child nodes. The Tree |
Children |
Allows you to populate a node with child nodes. The Tree |
Customize |
Allows you to customize text displayed within a cell. |
Customize |
Allows you to customize a cell editor in a data row. |
Customize |
Allows you to customize an automatically generated edit model or create a custom edit model. |
Customize |
Allows you to customize Tree |
Customize |
Allows you to customize column filter menu items. |
Customize |
Allows you to customize a cell editor in the filter row. |
Customize |
Allows you to customize the summary display text. |
Custom |
Allows you to implement custom logic used to sort data in the Tree |
Custom |
Allows you to create custom summary items. |
Data |
Fires after a user confirms the delete operation in the delete confirmation dialog. |
Edit |
Fires before the Tree |
Edit |
Fires if validation succeeds after a user saves changes or you call the Save |
Edit |
Fires before the Tree |
Filter |
Fires when filter criteria that is applied to Tree |
Focused |
Fires when row focus changes. |
Items |
Fires when a user drops rows onto the Tree |
Layout |
Fires when the Dx |
Layout |
Fires when the Tree |
Page |
Fires when the Tree |
Page |
Fires when the page size changes. |
Row |
Fires when a user clicks or taps a Tree |
Row |
Fires when a user double clicks a Tree |
Selected |
In single selection mode, fires when a Tree |
Selected |
In multiple selection mode, fires when the selection in the Tree |
Show |
Fires when the Show |