Skip to main content
BuyLog In
ASP.NET Web Forms Controls
Search in…
Docs > Client API Reference > DevExpress.Web.ASPxTreeList Scripts > ASPxClientTreeList > Members
All docs
V24.2
ASP.NET Web Forms Controls
.NET Support and Migration
Prerequisites
Supported Browsers
What's Installed
Get Started
Upgrade to a New Version
Common Concepts
Components
Security Considerations
Redistribution and Deployment
Troubleshooting
Get More Help
.NET Framework API Reference
Client API Reference
DevExpress.Web Scripts
DevExpress.Web.ASPxDiagram Scripts
DevExpress.Web.ASPxGantt Scripts
DevExpress.Web.ASPxGauges Scripts
DevExpress.Web.ASPxHtmlEditor Scripts
DevExpress.Web.ASPxPivotGrid Scripts
DevExpress.Web.ASPxRichEdit Scripts
DevExpress.Web.ASPxScheduler Scripts
DevExpress.Web.ASPxSpreadsheet Scripts
DevExpress.Web.ASPxTreeList Scripts
ASPxClientTreeListSelectionState
ASPxClientTreeList
Members
Properties
Methods
Events
ASPxClientTreeListBatchEditApi
ASPxClientTreeListBatchEditChangesCancelingEventArgs
ASPxClientTreeListBatchEditChangesSavingEventArgs
ASPxClientTreeListBatchEditConfirmShowingEventArgs
ASPxClientTreeListBatchEditEndEditingEventArgs
ASPxClientTreeListBatchEditNodeChangesCancelingEventArgs
ASPxClientTreeListBatchEditNodeDeletingEventArgs
ASPxClientTreeListBatchEditNodeInsertingEventArgs
ASPxClientTreeListBatchEditNodeRecoveringEventArgs
ASPxClientTreeListBatchEditNodeValidatingEventArgs
ASPxClientTreeListBatchEditStartEditingEventArgs
ASPxClientTreeListBatchEditTemplateCellFocusedEventArgs
ASPxClientTreeListCellInfo
ASPxClientTreeListCellSelectionChangingEventArgs
ASPxClientTreeListClipboardCellPastingEventArgs
ASPxClientTreeListColumn
ASPxClientTreeListColumnResizedEventArgs
ASPxClientTreeListColumnResizingEventArgs
ASPxClientTreeListContextMenuEventArgs
ASPxClientTreeListCustomButtonEventArgs
ASPxClientTreeListCustomDataCallbackEventArgs
ASPxClientTreeListEndDragNodeEventArgs
ASPxClientTreeListExportFormat
ASPxClientTreeListFocusedCellChangingEventArgs
ASPxClientTreeListKeyboardEventArgs
ASPxClientTreeListNodeEventArgs
ASPxClientTreeListStartDragNodeEventArgs
ASPxClientTreeListToolbarItemClickEventArgs
ASPxClientTreeListBatchEditChangesCancelingEventHandler<Sender>
ASPxClientTreeListBatchEditChangesSavingEventHandler<Sender>
ASPxClientTreeListBatchEditConfirmShowingEventHandler<Sender>
ASPxClientTreeListBatchEditEndEditingEventHandler<Sender>
ASPxClientTreeListBatchEditNodeChangesCancelingEventHandler<Sender>
ASPxClientTreeListBatchEditNodeDeletingEventHandler<Sender>
ASPxClientTreeListBatchEditNodeInsertingEventHandler<Sender>
ASPxClientTreeListBatchEditNodeRecoveringEventHandler<Sender>
ASPxClientTreeListBatchEditNodeValidatingEventHandler<Sender>
ASPxClientTreeListBatchEditStartEditingEventHandler<Sender>
ASPxClientTreeListBatchEditTemplateCellFocusedEventHandler<Sender>
ASPxClientTreeListCellSelectionChangingEventHandler<Sender>
ASPxClientTreeListClipboardCellPastingEventHandler<Sender>
ASPxClientTreeListColumnResizedEventHandler<Sender>
ASPxClientTreeListColumnResizingEventHandler<Sender>
ASPxClientTreeListContextMenuEventHandler<Sender>
ASPxClientTreeListCustomButtonEventHandler<Sender>
ASPxClientTreeListCustomDataCallbackEventHandler<Sender>
ASPxClientTreeListEndDragNodeEventHandler<Sender>
ASPxClientTreeListFocusedCellChangingEventHandler<Sender>
ASPxClientTreeListKeyboardEventHandler<Sender>
ASPxClientTreeListNodeEventHandler<Sender>
ASPxClientTreeListStartDragNodeEventHandler<Sender>
ASPxClientTreeListToolbarItemClickEventHandler<Sender>
ASPxClientTreeListValuesCallback
DevExpress.XtraCharts.Web Scripts
DevExpress.Web.ASPxSpellChecker Scripts
Download CHM

ASPxClientTreeList Members

Represents the client ASPxTreeList.

Properties

Name Description
batchEditApi Provides access to the batch editing client API.
name Gets the unique, hierarchically-qualified identifier for the control. Inherited from ASPxClientControlBase.

Methods

Name Description
AdjustControl Modifies the control’s size against the control’s container. Inherited from ASPxClientControl.
AdjustControls static Modifies the controls size within the specified container. Inherited from ASPxClientControl.
ApplyFilter(filterExpression) Applies the specified filter expression to the tree list.
ApplyOnClickRowFilter Applies a filter specified in the filter row to the ASPxTreeList.
ApplySearchPanelFilter(value) Applies the specified search panel filter criterion to tree list data.
AutoFilterByColumn(column, val) Applies a filter to the specified data column.
CancelEdit Cancels all the changes made and switches the ASPxTreeList to browse mode.
Cast(obj) static Converts the specified object to the ASPxClientTreeList type.
ClearFilter Clears the filter expression applied to a client Tree List.
CloseFilterControl Hides the Filter Control.
CollapseAll Collapses all Node.
CollapseNode(key) Collapses the specified node preserving the expanded state of child nodes.
DeleteNode(nodeKey) Deletes the specified node.
ExpandAll Expands all nodes.
ExpandNode(key) Expands the specified node preserving the collapsed state of child nodes.
ExportTo(format) Exports tree list data to a file in the specified format.
Focus Sets input focus to the ASPxTreeList.
FocusEditor(column) Moves focus to the specified editor within the edited node.
GetAutoFilterEditor(column) Returns the editor used to edit the value in the auto filter row for the specified data column.
GetClientVisible Obsolete. Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetColumnByFieldName(fieldName) Returns the client column which is bound to the specified data source field.
GetColumnByIndex(index) Returns the column located at the specified position within the ASPxTreeList.Columns collection.
GetColumnByName(name) Returns the column with the specified name.
GetColumnCount Returns the number of columns within the client ASPxTreeList.
GetControlCollection static Returns a collection of client web control objects. Inherited from ASPxClientControl.
GetEditingNodeKey Gets the key value of the node currently being edited.
GetEditor(column) Returns the editor used to edit the specified column’s values.
GetEditValue(column) Returns the value of the specified edit cell.
GetFocusedNodeKey Returns the focused node’s key value.
GetHeight Returns the control’s height. Inherited from ASPxClientControl.
GetHorizontalScrollPosition Returns the current horizontal scroll position of the tree list’s content.
GetMainElement Returns an HTML element that is the root of the control’s hierarchy. Inherited from ASPxClientControlBase.
GetNodeHtmlElement(nodeKey) Returns an HTML table row that represents the specified node.
GetNodeState(nodeKey) Returns the specified node’s state.
GetNodeValues(nodeKey, fieldNames, onCallback) Obtains specified data source field values within a specified node, and submits them to the specified JavaScript function.
GetPageCount Gets the number of pages to which the ASPxTreeList’s data is divided.
GetPageIndex Gets the index of the page currently being selected.
GetParentControl Returns a client instance of the control that is the parent for a specified control. Inherited from ASPxClientControlBase.
GetPopupEditForm Gets the Popup Edit Form.
GetSelectedNodeValues(fieldNames, onCallback) Obtains specified data source field values within selected nodes, and submits them to the specified JavaScript function.
GetToolbar(index) Returns a toolbar specified by its index.
GetToolbarByName(name) Returns a toolbar specified by its name.
GetVerticalScrollPosition Returns the current vertical scroll position of the tree list’s content.
GetVisible Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetVisibleColumnCount Returns the number of visible columns within the client ASPxTreeList.
GetVisibleNodeKeys Obtains key values of nodes that are displayed within the current page.
GetVisibleNodeValues(fieldNames, onCallback) Obtains specified data source field values within nodes that are displayed within the current page, and submits them to the specified JavaScript function.
GetVisibleSelectedNodeKeys Obtains key values of selected nodes that are displayed within the current page.
GetWidth Returns the control’s width. Inherited from ASPxClientControl.
GoToPage(index) Selects the specified page.
HideCustomizationWindow Closes the Customization Window.
InCallback Returns a value that determines whether a callback request sent by a web control is being currently processed on the server side. Inherited from ASPxClientControlBase.
IsCustomizationWindowVisible Indicates whether the Customization Window is displayed.
IsEditing Indicates whether the ASPxTreeList is in edit mode.
IsNodeSelected(nodeKey) Indicates whether the specified node is selected.
MakeNodeVisible(nodeKey) Scrolls the tree list so that the specified node becomes visible.
MoveNode(nodeKey, parentNodeKey) Moves the specified node to a new position.
NextPage Activates the next page.
PerformCallback(args) Sends a callback to the server and generates the server-side ASPxTreeList.CustomCallback event, passing it the specified argument.
PerformCustomCallback(arg) Obsolete. Sends a callback to the server and generates the server-side ASPxTreeList.CustomCallback event, passing it the specified argument.
PerformCustomDataCallback(arg) Sends a callback to the server and generates the server-side ASPxTreeList.CustomDataCallback event passing it the specified argument.
PrevPage Activates the previous page.
Refresh Updates the tree list data.
SelectNode(nodeKey) Selects or deselects the specified node.
SendMessageToAssistiveTechnology(message) Specifies the text that Assistive Technologies (screen readers or braille display, for example) will provide to a user. Inherited from ASPxClientControlBase.
SetClientVisible(visible) Obsolete. Specifies whether a control is displayed. Inherited from ASPxClientControlBase.
SetEditValue(column, value) Sets the value of the specified edit cell.
SetFilterEnabled(isFilterEnabled) Enables or disables the current filter.
SetFocusedNodeKey(key) Moves focus to the specified node.
SetHeight(height)

Specifies the control’s height. Note that this method is not in effect for some controls.

Inherited from ASPxClientControl.
SetHorizontalScrollPosition(position) Specifies the horizontal scroll position for the tree list’s content.
SetSearchPanelCustomEditor(editor) Specifies a custom editor for the search panel on the client side.
SetVerticalScrollPosition(position) Specifies the vertical scroll position for the tree list’s content.
SetVisible(visible) Specifies whether a control is displayed. Inherited from ASPxClientControlBase.
SetWidth(width) Specifies the control’s width in pixels. Inherited from ASPxClientControl.
ShowCustomizationWindow Invokes the Customization Window and displays it over the specified HTML element.
ShowFilterControl Displays the Filter Control.
SortBy(columnIndex) Sorts data by the specified data column‘s values.
StartEdit(nodeKey) Switches the ASPxTreeList to edit mode.
StartEditNewNode Switches the ASPxTreeList to edit mode and allows new node values to be edited.
UpdateEdit Saves all the changes made and switches the ASPxTreeList to browse mode.

Events

Name Description
BatchEditChangesCanceling Occurs on the client side before data changes are canceled in batch edit mode.
BatchEditChangesSaving Occurs on the client side before data changes are saved in batch edit mode.
BatchEditConfirmShowing Enables you to prevent a batch edit confirmation message from being displayed.
BatchEditEndEditing Occurs when a tree list leaves the batch edit mode.
BatchEditNodeChangesCanceling Allows you to handle a Cancel button click for a node in batch edit mode.
BatchEditNodeDeleting Occurs on the client side before a node is deleted in batch edit mode.
BatchEditNodeInserting Occurs on the client side before a node is inserted in batch edit mode.
BatchEditNodeRecovering Occurs on the client side before a node is recovered in batch edit mode.
BatchEditNodeValidating Enables you to specify whether the node date is valid and provide an error text.
BatchEditStartEditing Occurs when a tree list switches to batch edit mode.
BatchEditTemplateCellFocused Enables you to provide navigation for editors contained in a templated cell in Batch Edit mode.
BeginCallback Occurs when a callback for server-side processing is initiated.
CallbackError Fires on the client if any unhandled server error occurs during server-side processing of a callback sent by the ASPxClientTreeList.
CellSelectionChanging Occurs when you select or deselect a cell.
ClipboardCellPasting Occurs before a cell is pasted to the control from the clipboard. Allows you to update the pasted data or skip a cell.
ColumnResized Occurs after a column’s width has been changed by an end-user.
ColumnResizing Enables you to prevent columns from being resized.
ContextMenu Enables you to display a context menu.
CustomButtonClick Occurs when a custom command button has been clicked.
CustomDataCallback Fires after the callback has been processed in the ASPxTreeList.CustomDataCallback event handler.
CustomizationWindowCloseUp Fires after the Customization Window has been closed.
EndCallback Occurs on the client after a callback’s server-side processing has been completed.
EndDragNode Occurs after a node drag and drop operation is completed.
FocusedCellChanging Occurs on the client side when the focused cell is about to be changed.
FocusedNodeChanged Fires in response to changing node focus.
Init Occurs on the client side after the control has been initialized. Inherited from ASPxClientControlBase.
KeyDown Occurs when a user presses a key while ASPxTreeList has focus.
KeyPress Occurs when a user presses and releases a key while ASPxTreeList has focus.
KeyUp Occurs when a user releases the pressed key while ASPxTreeList has focus.
NodeClick Fires on the client when a node is clicked.
NodeCollapsing Fires before a node is collapsed.
NodeDblClick Fires on the client when a node is double clicked.
NodeExpanding Fires before a node is expanded.
NodeFocusing Fires before the focused node has been changed.
SelectionChanged Fires after the selection has been changed via end-user interaction.
StartDragNode Occurs before a node is dragged by an end-user.
ToolbarItemClick Fires after a toolbar item has been clicked.
See Also