DxTreeList Methods

Show Inherited Hide Inherited

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

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 currently visible page except for child rows of collapsed items.
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)	Deselects 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.
Equals(Object, Object) static	Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)	Determines whether the specified object is equal to the current object. Inherited from Object.
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 the 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)	Returns a data source item bound to the row with the specified visible index.
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.
GetHashCode()	Serves as the default hash function. Inherited from Object.
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.
GetType()	Gets the Type of the current instance. Inherited from Object.
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.
MemberwiseClone() protected	Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static	Determines whether the specified Object instances are the same instance. Inherited from Object.
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 currently visible page except for child rows of collapsed items.
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.
ToString()	Returns a string that represents the current object. Inherited from Object.
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 a remote data source is loaded.