MVCxClientTreeList Methods

A client-side counterpart of the TreeList extension.
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. Inherited from ASPxClientTreeList.
ApplyOnClickRowFilter Applies a filter specified in the filter row to the ASPxTreeList. Inherited from ASPxClientTreeList.
ApplySearchPanelFilter(value) Applies the specified search panel filter criterion to tree list data. Inherited from ASPxClientTreeList.
AutoFilterByColumn(column, val) Applies a filter to the specified data column. Inherited from ASPxClientTreeList.
CancelEdit Cancels all the changes made and switches the ASPxTreeList to browse mode. Inherited from ASPxClientTreeList.
Cast(obj) static Converts the specified object to the MVCxClientTreeList type.
ClearFilter Clears the filter expression applied to a client Tree List. Inherited from ASPxClientTreeList.
CloseFilterControl Hides the Filter Control. Inherited from ASPxClientTreeList.
CollapseAll Collapses all Node. Inherited from ASPxClientTreeList.
CollapseNode(key) Collapses the specified node preserving the expanded state of child nodes. Inherited from ASPxClientTreeList.
DeleteNode(nodeKey) Deletes the specified node. Inherited from ASPxClientTreeList.
ExpandAll Expands all nodes. Inherited from ASPxClientTreeList.
ExpandNode(key) Expands the specified node preserving the collapsed state of child nodes. Inherited from ASPxClientTreeList.
ExportTo(format) Exports tree list data to a file in the specified format. Inherited from ASPxClientTreeList.
Focus Sets input focus to the ASPxTreeList. Inherited from ASPxClientTreeList.
FocusEditor(column) Moves focus to the specified editor within the edited node. Inherited from ASPxClientTreeList.
GetAutoFilterEditor(column) Returns the editor used to edit the value in the auto filter row for the specified data column. Inherited from ASPxClientTreeList.
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. Inherited from ASPxClientTreeList.
GetColumnByIndex(index) Returns the column located at the specified position within the ASPxTreeList.Columns collection. Inherited from ASPxClientTreeList.
GetColumnByName(name) Returns the column with the specified name. Inherited from ASPxClientTreeList.
GetColumnCount Returns the number of columns within the client ASPxTreeList. Inherited from ASPxClientTreeList.
GetControlCollection static Returns a collection of client web control objects. Inherited from ASPxClientControl.
GetEditingNodeKey Gets the key value of the node currently being edited. Inherited from ASPxClientTreeList.
GetEditor(column) Returns the editor used to edit the specified column’s values. Inherited from ASPxClientTreeList.
GetEditValue(column) Returns the value of the specified edit cell. Inherited from ASPxClientTreeList.
GetFocusedCell Gets information about a focused cell. Inherited from ASPxClientTreeList.
GetFocusedNodeKey Returns the focused node’s key value. Inherited from ASPxClientTreeList.
GetHeight Returns the control’s height. Inherited from ASPxClientControl.
GetHorizontalScrollPosition Returns the current horizontal scroll position of the tree list’s content. Inherited from ASPxClientTreeList.
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. Inherited from ASPxClientTreeList.
GetNodeState(nodeKey) Returns the specified node’s state. Inherited from ASPxClientTreeList.
GetNodeValues(nodeKey, fieldNames, onCallback) Obtains specified data source field values within a specified node, and submits them to the specified JavaScript function. Inherited from ASPxClientTreeList.
GetPageCount Gets the number of pages to which the ASPxTreeList’s data is divided. Inherited from ASPxClientTreeList.
GetPageIndex Gets the index of the page currently being selected. Inherited from ASPxClientTreeList.
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. Inherited from ASPxClientTreeList.
GetSelectedNodeValues(fieldNames, onCallback) Obtains specified data source field values within selected nodes, and submits them to the specified JavaScript function. Inherited from ASPxClientTreeList.
GetToolbar(index) Returns a toolbar specified by its index. Inherited from ASPxClientTreeList.
GetToolbarByName(name) Returns a toolbar specified by its name. Inherited from ASPxClientTreeList.
GetVerticalScrollPosition Returns the current vertical scroll position of the tree list’s content. Inherited from ASPxClientTreeList.
GetVisible Returns a value specifying whether a control is displayed. Inherited from ASPxClientControlBase.
GetVisibleColumnCount Returns the number of visible columns within the client ASPxTreeList. Inherited from ASPxClientTreeList.
GetVisibleNodeKeys Obtains key values of nodes that are displayed within the current page. Inherited from ASPxClientTreeList.
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. Inherited from ASPxClientTreeList.
GetVisibleSelectedNodeKeys Obtains key values of selected nodes that are displayed within the current page. Inherited from ASPxClientTreeList.
GetWidth Returns the control’s width. Inherited from ASPxClientControl.
GoToPage(index) Selects the specified page. Inherited from ASPxClientTreeList.
HideCustomizationWindow Closes the Customization Window. Inherited from ASPxClientTreeList.
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. Inherited from ASPxClientTreeList.
IsEditing Indicates whether the ASPxTreeList is in edit mode. Inherited from ASPxClientTreeList.
IsNodeSelected(nodeKey) Indicates whether the specified node is selected. Inherited from ASPxClientTreeList.
MakeNodeVisible(nodeKey) Scrolls the tree list so that the specified node becomes visible. Inherited from ASPxClientTreeList.
MoveNode(nodeKey, parentNodeKey) Moves the specified node to a new position. Inherited from ASPxClientTreeList.
NextPage Activates the next page. Inherited from ASPxClientTreeList.
PerformCallback(data) Sends a callback with a parameter to update the TreeList by processing the passed information on the server, in an Action specified via the TreeList’s TreeListSettings.CustomActionRouteValues property.
PerformCustomCallback(arg) Obsolete. Sends a callback to the server and generates the server-side ASPxTreeList.CustomCallback event, passing it the specified argument. Inherited from ASPxClientTreeList.
PerformCustomDataCallback(data) Sends a callback with a parameter to process the passed information on the server, in an Action specified via the TreeList’s TreeListSettings.CustomDataActionRouteValues property, and then return the processing result to the client, to the ASPxClientTreeList.CustomDataCallback event. This method does not update the TreeList.
PrevPage Activates the previous page. Inherited from ASPxClientTreeList.
Refresh Updates the tree list data. Inherited from ASPxClientTreeList.
SelectNode(nodeKey) Selects or deselects the specified node. Inherited from ASPxClientTreeList.
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. Inherited from ASPxClientTreeList.
SetFilterEnabled(isFilterEnabled) Enables or disables the current filter. Inherited from ASPxClientTreeList.
SetFocusedCell(nodeKey, columnIndex) Focuses a specified cell. Inherited from ASPxClientTreeList.
SetFocusedNodeKey(key) Moves focus to the specified node. Inherited from ASPxClientTreeList.
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. Inherited from ASPxClientTreeList.
SetSearchPanelCustomEditor(editor) Specifies a custom editor for the search panel on the client side. Inherited from ASPxClientTreeList.
SetVerticalScrollPosition(position) Specifies the vertical scroll position for the tree list’s content. Inherited from ASPxClientTreeList.
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. Inherited from ASPxClientTreeList.
ShowFilterControl Displays the Filter Control. Inherited from ASPxClientTreeList.
SortBy(columnIndex) Sorts data by the specified data column‘s values. Inherited from ASPxClientTreeList.
StartEdit(nodeKey) Switches the ASPxTreeList to edit mode. Inherited from ASPxClientTreeList.
StartEditNewNode Switches the ASPxTreeList to edit mode and allows new node values to be edited. Inherited from ASPxClientTreeList.
UpdateEdit Saves all the changes made and switches the ASPxTreeList to browse mode. Inherited from ASPxClientTreeList.
See Also