ASPxTreeList Methods

Represents a server ASPxTreeList control.

Name Description
AddAttributesToRender(HtmlTextWriter) Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers.
(Inherited from WebControl)
AddParsedSubObject(Object) Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.
(Inherited from Control)
AddedControl(Control, Int32) Called after a child control is added to the Controls collection of the Control object.
(Inherited from Control)
AppendNode(Object)

Creates a new node and appends it to the Root.

AppendNode(Object, TreeListNode)

Creates a new node and appends it to the TreeListNode.ChildNodes collection of the specified node.

ApplyStyle(Style) Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.
(Inherited from WebControl)
ApplyStyleSheetSkin(Page) Applies the style properties defined in the page style sheet to the control.
(Inherited from Control)
AutoFilterByColumn(TreeListColumn, String)

Applies a filter to the specified data column.

BeginRenderTracing(TextWriter, Object) Begins design-time tracing of rendering data.
(Inherited from Control)
BuildProfileTree(String, Boolean) Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.
(Inherited from Control)
CancelEdit()

Cancels all the changes made and switches the ASPxTreeList to browse mode.

ClearCachedClientID() Sets the cached ClientID value to null.
(Inherited from Control)
ClearChildControlState() Deletes the control-state information for the server control's child controls.
(Inherited from Control)
ClearChildState() Deletes the view-state and control-state information for all the server control's child controls.
(Inherited from Control)
ClearChildViewState() Deletes the view-state information for all the server control's child controls.
(Inherited from Control)
ClearEffectiveClientIDMode() Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.
(Inherited from Control)
ClearNodes()

Removes all nodes contained within the ASPxTreeList.

ClearSort()

Clears sorting applied to the ASPxTreeList.

CollapseAll()

Collapses all Node.

CopyBaseAttributes(WebControl) Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.
(Inherited from WebControl)
CreateControlCollection() Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.
(Inherited from Control)
CreateNodeIterator(Boolean)

Returns a new Node Iterator with the specified settings.

DataBind()

Binds the data source to the invoked server control.

(Inherited from ASPxWebControl)
DataBind(Boolean) Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event.
(Inherited from Control)
DataBindChildren() Binds a data source to the server control's child controls.
(Inherited from Control)
DeleteNode(String)

Deletes the specified node.

Dispose() Enables a server control to perform final clean up before it is released from memory.
(Inherited from Control)
DoNodeValidation()

Validates the node currently being edited.

EndRenderTracing(TextWriter, Object) Ends design-time tracing of rendering data.
(Inherited from Control)
EnsureID() Creates an identifier for controls that do not have an identifier assigned.
(Inherited from Control)
Equals(Object) Determines whether the specified object is equal to the current object.
(Inherited from Object)
Equals(Object, Object) static Determines whether the specified object instances are considered equal.
(Inherited from Object)
ExpandAll()

Expands all nodes.

ExpandToLevel(Int32)

Expands the parent nodes down to the specified nesting level.

ExportDocxToResponse()

Exports the ASPxTreeList's data to a file in DOCX format, and writes it to the response in binary format.

ExportDocxToResponse(Boolean)

Exports the ASPxTreeList's data to a file in DOCX format with the specified settings, and writes it to the response in binary format.

ExportDocxToResponse(Boolean, DocxExportOptions)

Exports the ASPxTreeList's data to the specified file in DOCX format with the specified settings, and writes it to the response in binary format.

ExportDocxToResponse(DocxExportOptions)

Exports the ASPxTreeList's data to a file in DOCX format with the specified settings, and writes it to the response in binary format.

ExportDocxToResponse(String)

Exports the ASPxTreeList's data to the specified file in DOCX format, and writes it to the response in binary format.

ExportDocxToResponse(String, Boolean)

Exports the ASPxTreeList's data to the specified file in DOCX format with the specified settings, and writes it to the response in binary format.

ExportDocxToResponse(String, DocxExportOptions)

Exports the ASPxTreeList's data to the specified file in DOCX format with the specified settings, and writes it to the response in binary format.

ExportPdfToResponse()

Exports the ASPxTreeList's data to a file in PDF format, and writes it to the response in binary format.

ExportPdfToResponse(Boolean)

Exports the ASPxTreeList's data to a file in PDF format with the specified export settings, and writes it to the response in binary format.

ExportPdfToResponse(Boolean, PdfExportOptions)

Exports the ASPxTreeList's data to a file in PDF format with the specified export settings, and writes it to the response in binary format.

ExportPdfToResponse(PdfExportOptions)

Exports the ASPxTreeList's data to a file in PDF format with the specified export settings, and writes it to the response in binary format.

ExportPdfToResponse(String)

Exports the ASPxTreeList's data to the specified file in PDF format, and writes it to the response in binary format.

ExportPdfToResponse(String, Boolean)

Exports the ASPxTreeList's data to the specified file in PDF format with the specified export settings, and writes it to the response in binary format.

ExportPdfToResponse(String, PdfExportOptions)

Exports the ASPxTreeList's data to the specified file in PDF format with the specified export settings, and writes it to the response in binary format.

ExportRtfToResponse()

Exports the ASPxTreeList's data to a file in RTF format, and writes it to the response in binary format.

ExportRtfToResponse(Boolean)

Exports the ASPxTreeList's data to a file in RTF format with the specified settings, and writes it to the response in binary format.

ExportRtfToResponse(Boolean, RtfExportOptions)

Exports the ASPxTreeList's data to a file in RTF format with the specified setting, and writes it to the response in binary format.

ExportRtfToResponse(RtfExportOptions)

Exports the ASPxTreeList's data to a file in RTF format with the specified settings, and writes it to the response in binary format.

ExportRtfToResponse(String)

Exports the ASPxTreeList's data to the specified file in RTF format, and writes it to the response in binary format.

ExportRtfToResponse(String, Boolean)

Exports the ASPxTreeList's data to the specified file in RTF format with the specified settings, and writes it to the response in binary format.

ExportRtfToResponse(String, RtfExportOptions)

Exports the ASPxTreeList's data to the specified file in RTF format with the specified settings, and writes it to the response in binary format.

ExportToDocx(Stream)

Exports the ASPxTreeList's data to the specified file in DOCX format.

ExportToDocx(Stream, DocxExportOptions)

Exports the ASPxTreeList's data to the specified stream in DOCX format using the specified options.

ExportToPdf(Stream)

Exports the ASPxTreeList's data to the specified stream in PDF format.

ExportToPdf(Stream, PdfExportOptions)

Exports the ASPxTreeList's data to the specified stream in PDF format using the specified options.

ExportToRtf(Stream)

Exports the ASPxTreeList's data to the specified stream in RTF format.

ExportToRtf(Stream, RtfExportOptions)

Exports the ASPxTreeList's data to the specified stream in RTF format using the specified options.

ExportToXls(Stream)

Exports the ASPxTreeList's data to the specified stream in XLS format.

ExportToXls(Stream, XlsExportOptionsEx)

Exports the control's data to the specified stream in XLS format using the specified options.

ExportToXlsx(Stream)

Exports the ASPxTreeList's data to the specified file in XLSX (MS Excel 2007) format using the specified options.

ExportToXlsx(Stream, XlsxExportOptionsEx)

Exports the control's data to the specified file in XLSX (MS Excel 2007) format using the specified options.

ExportXlsToResponse()

Exports the ASPxTreeList's data to the specified file in XLS format with the specified export settings, and writes it to the response in binary format.

ExportXlsToResponse(Boolean)

Exports the ASPxTreeList's data to a file in XLS format with the specified export settings, and writes it to the response in binary format.

ExportXlsToResponse(Boolean, XlsExportOptionsEx)

Exports the tree list's data to a file in XLS format and writes it to the response in binary format.

ExportXlsToResponse(String)

Exports the ASPxTreeList's data to the specified file in XLS format, and writes it to the response in binary format.

ExportXlsToResponse(String, Boolean)

Exports the ASPxTreeList's data to the specified file in XLS format with the specified export settings, and writes it to the response in binary format.

ExportXlsToResponse(String, XlsExportOptionsEx)

Exports the tree list's data to the specified file in XLS format with the specified export settings, and writes it to the response in binary format.

ExportXlsToResponse(XlsExportOptionsEx)

Exports the tree list's data to the specified file in XLS format with the specified export settings, and writes it to the response in binary format.

ExportXlsxToResponse()

Exports the ASPxTreeList's data to a file in XLSX format, and writes it to the response in binary format.

ExportXlsxToResponse(Boolean)

Exports the ASPxTreeList's data to a file in XLSX format with the specified export settings, and writes it to the response in binary format.

ExportXlsxToResponse(Boolean, XlsxExportOptionsEx)

Exports the tree list's data to the specified file in XLSX format with the specified export settings, and writes it to the response in binary format.

ExportXlsxToResponse(String)

Exports the ASPxTreeList's data to the specified file in XLSX format, and writes it to the response in binary format.

ExportXlsxToResponse(String, Boolean)

Exports the ASPxTreeList's data to the specified file in XLSX format with the specified export settings, and writes it to the response in binary format.

ExportXlsxToResponse(String, XlsxExportOptionsEx)

Exports the grid's data to the specified file in XLSX format with the specified export settings, and writes it to the response in binary format.

ExportXlsxToResponse(XlsxExportOptionsEx)

Exports the tree list's data to the specified file in XLSX format, and writes it to the response in binary format.

FindControl(String) Searches the current naming container for a server control with the specified id parameter.
(Inherited from Control)
FindControl(String, Int32) Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method.
(Inherited from Control)
FindDataCellTemplateControl(String, TreeListDataColumn, String)

Searches for the server control contained within the specified data cell's template.

FindEditCellTemplateControl(TreeListDataColumn, String)

Searches for the specified server control contained within the specified edit cell's template.

FindEditFormTemplateControl(String)

Searches for the specified server control contained within the Edit Form's template.

FindFilterCellTemplateControl(TreeListColumn, String)

Searches for the server control contained within the specified filter row cell template.

FindFilterRowTemplateControl(String)

Searches for the server control contained within the specified filter row template.

FindFooterTemplateControl(TreeListColumn, String)

Searches for the server control contained within the Footer's template.

FindGroupFooterTemplateControl(String, TreeListColumn, String)

Searches for the server control contained within the specified group's footer template.

FindHeaderCaptionTemplateControl(TreeListColumn, String)

Searches for the specified server control contained within the column header's caption template.

FindInlineEditCellTemplateControl(TreeListDataColumn, String)

Obsolete. Searches for the specified server control contained within the specified cell's template displayed within the In-Line Edit Node.

FindNodeByFieldValue(String, Object)

Returns a node by its value in the specified column.

FindNodeByKeyValue(String)

Returns a node by its key value.

FindNodesByFieldValue(String, Object)

Returns a list of nodes that contain the specified value in the specified column.

FindPreviewTemplateControl(String, String)

Searches for the specified server control contained within the specified preview's template.

Focus()

Sets input focus to the web control.

(Inherited from ASPxWebControl)
GetAllNodes()

Returns a list of all nodes displayed within the ASPxTreeList.

GetCallbackErrorMessage() static

Obtains the error info while processing the redirection page.

(Inherited from ASPxWebControl)
GetClientSideEventHandler(String)

Returns the specified client event's handler.

(Inherited from ASPxWebControl)
GetCssClassNamePrefix()

For internal use only.

(Inherited from ASPxWebControl)
GetCssClassNamePrefix(String)

For internal use only.

(Inherited from ASPxWebControl)
GetDefaultBooleanProperty(String, DefaultBoolean)

For internal use only.

(Inherited from ASPxWebControl)
GetDesignModeState() Gets design-time data for a control.
(Inherited from Control)
GetHashCode() Serves as the default hash function.
(Inherited from Object)
GetResourceUrl(Page, String) static

Returns a URL reference to an embedded resource in an assembly.

(Inherited from ASPxWebControl)
GetResourceUrl(Page, Type, String) static

Returns a URL reference to an embedded resource in an assembly.

(Inherited from ASPxWebControl)
GetRouteUrl(Object) Gets the URL that corresponds to a set of route parameters.
(Inherited from Control)
GetRouteUrl(RouteValueDictionary) Gets the URL that corresponds to a set of route parameters.
(Inherited from Control)
GetRouteUrl(String, Object) Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from Control)
GetRouteUrl(String, RouteValueDictionary) Gets the URL that corresponds to a set of route parameters and a route name.
(Inherited from Control)
GetSelectedNodes()

Returns a list of selected nodes.

GetSelectedNodes(Boolean)

Returns a list of selected nodes.

GetSummaryValue(TreeListNode, TreeListSummaryItem)

Returns the specified summary value.

GetType() Gets the Type of the current instance.
(Inherited from Object)
GetUniqueIDRelativeTo(Control) Returns the prefixed portion of the UniqueID property of the specified control.
(Inherited from Control)
GetVirtualNodeObject(TreeListNode)

Returns a data object for the specified node when an ASPxTreeList operates in virtual mode.

GetVisibleNodes()

Returns a list of nodes that are visible on-screen.

HasControls() Determines if the server control contains any child controls.
(Inherited from Control)
HasEvents() Returns a value indicating whether events are registered for the control or any child controls.
(Inherited from Control)
HideFilterControl()

Hides the Filter Control.

HtmlEncode(String)

For internal use only.

(Inherited from ASPxWebControl)
HtmlEncode(String, Boolean)

For internal use only.

(Inherited from ASPxWebControl)
IAttributeAccessor.GetAttribute(String) Gets an attribute of the Web control with the specified name.
(Inherited from WebControl)
IAttributeAccessor.SetAttribute(String, String) Sets an attribute of the Web control to the specified name and value.
(Inherited from WebControl)
IControlDesignerAccessor.GetDesignModeState() For a description of this member, see GetDesignModeState().
(Inherited from Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary) For a description of this member, see SetDesignModeState(IDictionary).
(Inherited from Control)
IControlDesignerAccessor.SetOwnerControl(Control) For a description of this member, see SetOwnerControl(Control).
(Inherited from Control)
IParserAccessor.AddParsedSubObject(Object) For a description of this member, see AddParsedSubObject(Object).
(Inherited from Control)
IsAccessibilityCompliantRender()

Returns a value that indicates whether the control's accessible html code is rendered.

(Inherited from ASPxWebControl)
IsAccessibilityCompliantRender(Boolean)

Returns a value that indicates whether the control's accessible html code is rendered.

(Inherited from ASPxWebControl)
IsClientSideAPIEnabled()

Returns a value that indicates whether a specific programmatic interface (in particular, specific JavaScript objects and methods) are available to the control on the client side.

(Inherited from ASPxWebControl)
IsEnabled()

Returns a value that specifies whether a web control is enabled.

(Inherited from ASPxWebControlBase)
IsLiteralContent() Determines if the server control holds only literal content.
(Inherited from Control)
IsLoading()

This member supports the internal infrastructure and is not intended to be used directly from your code.

(Inherited from ASPxWebControl)
IsVirtualMode()

Indicates whether the ASPxTreeList operates in Virtual Mode.

IsVisible()

Returns a value that specifies whether the current web control is displayed.

(Inherited from ASPxWebControlBase)
LoadClientLayout(Byte[])

Restores a ASPxTreeList layout from the specified parameter.

LoadControlState(Object) Restores control-state information from a previous page request that was saved by the SaveControlState() method.
(Inherited from Control)
MakeResponseCompressed() static

Specifies that the response code (the HTML code of the web page) should be compressed on the server before sending it to the client.

(Inherited from ASPxWebControl)
MakeResponseCompressed(Boolean) static

Specifies that the response code (the HTML code of the web page) should be compressed on the server before sending it to the client, and accepts a parameter specifying whether to apply compression to IE6.

(Inherited from ASPxWebControl)
MapPathSecure(String) Retrieves the physical path that a virtual path, either absolute or relative, maps to.
(Inherited from Control)
MemberwiseClone() Creates a shallow copy of the current Object.
(Inherited from Object)
MergeStyle(Style) Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.
(Inherited from WebControl)
MoveNode(String, String)

Moves the specified node to a new position.

OnBubbleEvent(Object, EventArgs) Determines whether the event for the server control is passed up the page's UI server control hierarchy.
(Inherited from Control)
OnDataBinding(EventArgs) Raises the DataBinding event.
(Inherited from Control)
OnUnload(EventArgs) Raises the Unload event.
(Inherited from Control)
OpenFile(String) Gets a Stream used to read a file.
(Inherited from Control)
RaiseBubbleEvent(Object, EventArgs) Assigns any sources of the event and its information to the control's parent.
(Inherited from Control)
RedirectOnCallback(String) static

Redirects a client to a new URL while processing a callback.

(Inherited from ASPxWebControl)
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance.
(Inherited from Object)
RefreshVirtualTree()

Rebuilds a virtual tree.

RefreshVirtualTree(TreeListNode)

Rebuilds the tree, starting from the specified node.

RegisterBaseScript(Page) static

Registers base scripts, required to embed an ASPxWebControl control onto the specified page.

(Inherited from ASPxWebControl)
RegisterBaseScript(Page, Boolean) static

Registers base scripts required to embed an ASPxWebControl control onto the specified page.

(Inherited from ASPxWebControl)
RegisterStyleSheets()

For internal use only.

RegisterUtilsScript(Page) static

Obsolete. Registers utils scripts required to embed an ASPxWebControl control onto the specified page.

(Inherited from ASPxWebControl)
RemovedControl(Control) Called after a child control is removed from the Controls collection of the Control object.
(Inherited from Control)
RenderBeginTag(HtmlTextWriter) Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.
(Inherited from WebControl)
RenderChildren(HtmlTextWriter) Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
(Inherited from Control)
RenderContents(HtmlTextWriter) Renders the contents of the control to the specified writer. This method is used primarily by control developers.
(Inherited from WebControl)
RenderControl(HtmlTextWriter) Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
(Inherited from Control)
RenderControl(HtmlTextWriter, ControlAdapter) Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.
(Inherited from Control)
RenderEndTag(HtmlTextWriter) Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.
(Inherited from WebControl)
RequireClientLibrariesRegistering() static

Specifies whether client library registration is required.

(Inherited from ASPxWebControl)
ResolveAdapter() Gets the control adapter responsible for rendering the specified control.
(Inherited from Control)
ResolveClientUrl(String)

Gets a URL that can be used by the browser.

(Inherited from ASPxWebControlBase)
ResolveUrl(String) Converts a URL into one that is usable on the requesting client.
(Inherited from Control)
SaveClientLayout()

Saves the ASPxTreeList layout.

SaveControlState() Saves any server control state changes that have occurred since the time the page was posted back to the server.
(Inherited from Control)
SelectAll(Boolean)

Selects all nodes with the specified settings.

SetBatchEditInsertedNodeKeyValue(Object)

Returns the key value for the inserted node.

SetCallbackErrorMessage(String) static

Specifies the message text to be displayed for remote clients when a DevExpress control callback error has occurred.

(Inherited from ASPxWebControl)
SetClientSideEventHandler(String, String)

Defines a handler for the specified client event.

(Inherited from ASPxWebControl)
SetDefaultBooleanProperty(String, DefaultBoolean, DefaultBoolean)

For internal use only.

(Inherited from ASPxWebControl)
SetDesignModeState(IDictionary) Sets design-time data for a control.
(Inherited from Control)
SetIECompatibilityMode(Int32) static

Switches all DevExpress controls on a page to use the specified IE version.

(Inherited from ASPxWebControl)
SetIECompatibilityMode(Int32, Control) static

Obsolete. Switches all DevExpress controls on the specified page to use the specified IE version.

(Inherited from ASPxWebControl)
SetIECompatibilityModeEdge() static

Switches all DevExpress controls on a page to use the latest IE version.

(Inherited from ASPxWebControl)
SetIECompatibilityModeEdge(Control) static

Obsolete. Switches all DevExpress controls on the specified page to use the latest IE version.

(Inherited from ASPxWebControl)
SetRenderMethodDelegate(RenderMethod) Assigns an event handler delegate to render the server control and its content into its parent control.
(Inherited from Control)
SetTraceData(Object, Object) Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value.
(Inherited from Control)
SetTraceData(Object, Object, Object) Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value.
(Inherited from Control)
ShowFilterControl()

Displays the filter control.

SortBy(TreeListDataColumn, ColumnSortOrder)

Sorts data by the specified column's values.

SortBy(TreeListDataColumn, Int32)

Sorts data by the values of the specified data column, and places the column in the specified position among the sorted columns.

StartEdit(String)

Switches the ASPxTreeList to edit mode.

StartEditNewNode(String)

Switches the ASPxTreeList to edit mode and allows new node values to be edited.

ToString() Returns a string that represents the current object.
(Inherited from Object)
UnselectAll(Boolean)

Unselects all tree list nodes.

UpdateEdit()

Saves all the changes made, and switches the ASPxTreeList to browse mode.

See Also