Back to Devexpress

ASPxTreeList Members

aspnet-devexpress-dot-web-dot-aspxtreelist-dot-aspxtreelist-dot-underscore-members.md

latest110.4 KB
Original Source

ASPxTreeList Members

Represents a server ASPxTreeList control.

Constructors

NameDescription
ASPxTreeList()Initializes a new instance of the ASPxTreeList class with default settings.

Properties

NameDescription
AccessibilityCompliantEnables accessibility support.
AccessKeyGets or sets the access key that allows you to quickly navigate to the Web server control. Inherited from WebControl.
Adapter protectedGets the browser-specific adapter for the control. Inherited from Control.
AppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. Inherited from Control.
AttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from WebControl.
AutoGenerateColumnsGets or sets whether columns are automatically created for all fields in the underlying data source.
AutoGenerateServiceColumnsGets or sets whether columns are automatically created for service fields in the underlying data source.
BackColorGets or sets the background color of the Web server control. Inherited from WebControl.
BackgroundImageGets the web control’s background image. Inherited from ASPxWebControl.
BackwardCompatibility staticProvides access to the control’s backward compatibility settings. Inherited from ASPxWebControl.
BorderGets the web control’s border settings. Inherited from ASPxWebControl.
BorderBottomGets the settings of the web control’s bottom border. Inherited from ASPxWebControl.
BorderLeftGets the settings of the web control’s left border. Inherited from ASPxWebControl.
BorderRightGets the settings of the web control’s right border. Inherited from ASPxWebControl.
BorderTopGets the settings of the web control’s top border. Inherited from ASPxWebControl.
BoundGets a value that specifies whether the control is data bound. Inherited from ASPxDataWebControlBase.
CaptionGets or sets the text to render in an HTML caption element in an ASPxTreeList.
ClientIDGets the control’s identifier generated by ASP.NET. Inherited from ASPxWebControlBase.
ClientIDModeGets or sets the algorithm that is used to generate the value of the ClientID property. Inherited from Control.
ClientIDSeparator protectedGets a character value representing the separator character used in the ClientID property. Inherited from Control.
ClientInstanceNameGets or sets the ASPxTreeList’s client programmatic identifier.
ClientSideEventsGets an object that lists the client-side events specific to the ASPxTreeList.
ClientVisibleGets or sets a value that specifies the initial visibility state of a web control on the client.
ColumnsProvides access to an ASPxTreeList’s column collection.
Context protectedGets the HttpContext object associated with the server control for the current Web request. Inherited from Control.
ControlsGets the web control’s collection of child controls. Inherited from ASPxWebControlBase.
ControlStyleGets the style of the Web server control. This property is used primarily by control developers. Inherited from WebControl.
ControlStyleCreatedGets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. Inherited from WebControl.
CssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. Inherited from WebControl.
CssFilePathGets or sets the path to a CSS file that defines the control’s appearance.
CssPostfixGets or sets a CSS class name postfix that identifies style settings to be applied to the control.
CursorGets or sets the type of cursor to display when the mouse pointer is over the web control. Inherited from ASPxWebControl.
DataCacheModeGets or sets whether data caching is enabled.
DataColumnsGets the collection of data columns within the ASPxTreeList control.
DataItemContainerGets a reference to the naming container if the naming container implements IDataItemContainer. Inherited from Control.
DataKeysContainerGets a reference to the naming container if the naming container implements IDataKeysControl. Inherited from Control.
DataMemberGets or sets the name of the list of data that the data-bound control binds to, in instances where the data source contains more than one distinct list of data items. Inherited from ASPxDataWebControl.
DataSourceGets or sets the ASPxTreeList’s data source.
DataSourceIDSpecifies the control’s data source ID. Inherited from ASPxDataWebControl.
DisabledCssClass staticGets or sets the CSS class to apply to the rendered HTML element when the control is disabled. Inherited from WebControl.
DisabledStyleGets the style settings which define a control’s appearance in the disabled state. Inherited from ASPxWebControl.
EditingNodeKeyGets the key value of the node currently being edited.
EmptyImage staticObsolete. Gets the settings of an image which is displayed by the control if the control’s value is null. Inherited from ASPxWebControl.
EnableCallbackAnimationGets or sets a value that specifies whether a specific animation effect is used when a control’s content is updated via a callback.
EnableCallbackCompressionGets or sets whether callback compression is enabled.
EnableCallbacksGets or sets a value that specifies whether the callback or postback technology is used to manage round trips to the server.
EnabledGets or sets a value that indicates whether a web control is enabled, allowing it to respond to user interactions. Inherited from ASPxWebControl.
EnableDefaultAppearanceObsolete. Specifies whether to enable the control’s default appearance. Inherited from ASPxWebControl.
EnablePagingCallbackAnimationGets or sets a value that specifies whether a specific animation effect is used when changing pages.
EnablePagingGesturesGets or sets a value specifying whether an end-user can switch pages with a swipe gesture.
EnableThemingGets or sets a value indicating whether themes apply to this control. Inherited from WebControl.
EnableViewStateGets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. Inherited from Control.
Events protectedGets a list of event handler delegates for the control. This property is read-only. Inherited from Control.
FilterEnabledGets or sets whether the current filter is enabled.
FilterExpressionGets or sets the filter criterion which is applied to the tree list.
FocusedNodeGets the focused node.
FontGets the font properties associated with the Web server control. Inherited from WebControl.
ForeColorGets or sets the foreground color (typically the color of the text) of the Web server control. Inherited from WebControl.
GlobalAccessibilityCompliant staticGets or sets whether accessibility support is globally enabled for all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl.
GlobalCheckReferencesToExternalScripts staticGets or sets whether links to external client scripts (such as jQuery, Knockout, and others), which are used by some DevExpress web components, are checked for presence and correctness. Inherited from ASPxWebControl.
GlobalEmbedRequiredClientLibraries staticObsolete. Gets or sets whether external client libraries (including scripts and CSS files) are automatically embedded in the DevExpress.Web assembly as resources. Inherited from ASPxWebControl.
GlobalRightToLeft staticGets or sets that the right-to-left orientation shall be globally applied to all DevExpress web controls across the web page or the entire web site. Inherited from ASPxWebControl.
GlobalStyleSheetTheme staticGets or sets the name of the style sheet theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl.
GlobalTheme staticGets or sets the name of the Theme to be globally applied to all DevExpress web controls across the entire web site. Inherited from ASPxWebControl.
GlobalThemeBaseColor staticGets or sets the base color for the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl.
GlobalThemeFont staticGets or sets the font settings of the theme to be globally applied to all DevExpress web controls across a web page or entire web site. Inherited from ASPxWebControl.
HasAttributesGets a value indicating whether the control has attributes set. Inherited from WebControl.
HasChildViewState protectedGets a value indicating whether the current server control’s child controls have any saved view-state settings. Inherited from Control.
HeightGets or sets the height of the web server control. Inherited from ASPxWebControl.
IDGets or sets the programmatic identifier assigned to the server control. Inherited from Control.
IdSeparator protectedGets the character used to separate control identifiers. Inherited from Control.
ImagesProvides access to the settings that define images displayed within the ASPxTreeList’s elements.
ImagesEditorsProvides access to the settings that define images displayed within the ASPxTreeList’s editors.
ImagesFilterControlProvides access to the settings that define images displayed in the Filter Control.
InitializedGets a value indicating whether the web control has been initialized. Inherited from ASPxWebControlBase.
IsCallbackGets a value indicating whether the request is the result of a callback sent by the control. Inherited from ASPxWebControl.
IsChildControlStateCleared protectedGets a value indicating whether controls contained within this control have control state. Inherited from Control.
IsEditingIndicates whether the ASPxTreeList is in edit mode.
IsFilterControlVisibleIndicates whether the Filter Control is displayed.
IsNewNodeEditingIndicates whether a new node is being edited.
IsTrackingViewState protectedGets a value that indicates whether the server control is saving changes to its view state. Inherited from Control.
IsViewStateEnabled protectedGets a value indicating whether view state is enabled for this control. Inherited from Control.
JSPropertiesGets a collection of temporary client properties.
KeyboardSupportGets or sets a value that specifies whether keyboard navigation is available within the ASPxTreeList control.
KeyFieldNameGets or sets the name of the data source key field.
LoadedIndicates whether a web control has been loaded into the Page object. Inherited from ASPxWebControlBase.
LoadViewStateByID protectedGets a value indicating whether the control participates in loading its view state by ID instead of index. Inherited from Control.
NamingContainerGets a reference to the server control’s naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. Inherited from Control.
NewNodeParentKeyGets the key value of a new node’s parent.
NodesProvides access to the root nodes child collection.
PaddingsGets the control’s padding settings.
PageGets a reference to the Page instance that contains the server control. Inherited from Control.
PageIndexGets or sets the index of the currently selected page.
ParentGets a reference to the server control’s parent control in the page control hierarchy. Inherited from Control.
ParentFieldNameGets or sets the data source field which contains parent node values.
ParentImagesThis property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
ParentStylesThis property is not in effect for the ASPxWebControl class. Inherited from ASPxWebControl.
PreviewEncodeHtmlGets or sets whether to encode preview row content.
PreviewFieldNameGets or sets the name of the data source field whose values are displayed within preview rows.
RenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. Inherited from Control.
RightToLeftSpecifies whether to apply right-to-left representation to the control.
RootNodeProvides access to the root node.
RootValueGets or sets the value that root nodes contain in the field specified by the ASPxTreeList.ParentFieldName property.
SearchPanelFilterGets or sets the filter criterion that is applied to the tree list using the search panel.
SelectionCountGets the number of selected nodes within the ASPxTreeList.
SettingsProvides access to the ASPxTreeList’s display options.
SettingsBehaviorProvides access to the control’s behavior settings.
SettingsCookiesProvides access to the ASPxTreeList cookie and layout settings.
SettingsDataSecuritySecurity settings that allow you to disable data operations in the ASPxTreeList.
SettingsEditingProvides access to the ASPxTreeList’s editing settings.
SettingsExportProvides access to the ASPxTreeList’s export settings.
SettingsFilterControlProvides access to the filter control‘s settings.
SettingsLoadingPanelProvides access to the Loading Panel’s settings.
SettingsPagerProvides access to the Pager‘s settings.
SettingsPopupProvides access to the settings of different grid popup elements.
SettingsResizingProvides access to the TreeList’s resizing settings.
SettingsSearchPanelProvides access to the search panel‘s settings.
SettingsSelectionProvides access to the control’s selection options.
SettingsTextProvides access to the control’s text settings.
ShadowImage staticObsolete. Gets the shadow image properties. Inherited from ASPxWebControl.
SiteGets information about the container that hosts the current control when rendered on a design surface. Inherited from Control.
SkinIDGets or sets the skin to apply to the control. Inherited from WebControl.
SortCountGets the number of columns involved in sorting.
StyleGets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. Inherited from WebControl.
StylesProvides access to the style settings that control the appearance of the ASPxTreeList’s elements.
StylesEditorsProvides access to style settings used to paint ASPxTreeList’s editors.
StylesExportProvides access to the style settings defining the appearance of the exported document.
StylesFilterControlGets style settings defining the appearance of the filter control.
StylesPagerProvides access to the style settings that control the appearance of the Pager displayed within the ASPxTreeList.
StylesPopupProvides access to the style settings defining the appearance of different popup elements within a tree list.
StylesToolbarProvides access to the style settings that define the appearance of toolbars.
SummaryProvides access to summary items.
SummaryTextGets or sets a value that describes the ASPxTreeList’s contents.
SupportsDisabledAttributeGets a value that indicates whether the control should set the disabled attribute of the rendered HTML element to “disabled” when the control’s IsEnabled property is false. Inherited from WebControl.
IControlBuilderAccessor.ControlBuilderFor a description of this member, see ControlBuilder. Inherited from Control.
IControlDesignerAccessor.UserDataFor a description of this member, see UserData. Inherited from Control.
IDataBindingsAccessor.DataBindingsFor a description of this member, see DataBindings. Inherited from Control.
IDataBindingsAccessor.HasDataBindingsFor a description of this member, see HasDataBindings. Inherited from Control.
IExpressionsAccessor.ExpressionsFor a description of this member, see Expressions. Inherited from Control.
IExpressionsAccessor.HasExpressionsFor a description of this member, see HasExpressions. Inherited from Control.
TabIndexGets or sets the tab index of the Web server control. Inherited from WebControl.
TagKey protectedGets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. Inherited from WebControl.
TagName protectedGets the name of the control tag. This property is used primarily by control developers. Inherited from WebControl.
TemplateControlGets or sets a reference to the template that contains this control. Inherited from Control.
TemplatesProvides access to the templates used to display the ASPxTreeList’s elements (cells, column headers, etc.).
TemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. Inherited from Control.
ThemeGets or sets the name of the Theme to be applied to the control. Inherited from ASPxWebControl.
ToolbarsGets the collection of toolbars in the ASPxTreeList control.
ToolTipGets or sets the text displayed when the mouse pointer hovers over the Web server control. Inherited from WebControl.
TotalNodeCountGets the total number of nodes contained within the ASPxTreeList.
UniqueIDGets the unique, hierarchically qualified identifier for the server control. Inherited from Control.
ValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. Inherited from Control.
ViewState protectedGets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. Inherited from Control.
ViewStateIgnoresCase protectedGets a value that indicates whether the StateBag object is case-insensitive. Inherited from Control.
ViewStateModeGets or sets the view-state mode of this control. Inherited from Control.
VisibleGets or sets a value that indicates whether a server control is rendered as UI on the page. Inherited from Control.
VisibleColumnsGets a collection of visible columns within the ASPxTreeList.
WidthGets or sets the width of the web server control. Inherited from ASPxWebControl.

Methods

NameDescription
AddAttributesToRender(HtmlTextWriter) protectedAdds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. Inherited from WebControl.
AddedControl(Control, Int32) protectedCalled after a child control is added to the Controls collection of the Control object. Inherited from Control.
AddParsedSubObject(Object) protectedNotifies 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.
AppendNode(Object, TreeListNode)Creates a new node and appends it to the TreeListNode.ChildNodes collection of the specified node.
AppendNode(Object)Creates a new node and appends it to the Root.
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) protectedBegins design-time tracing of rendering data. Inherited from Control.
BuildProfileTree(String, Boolean) protectedGathers 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() protectedSets the cached ClientID value to null. Inherited from Control.
ClearChildControlState() protectedDeletes the control-state information for the server control’s child controls. Inherited from Control.
ClearChildState() protectedDeletes the view-state and control-state information for all the server control’s child controls. Inherited from Control.
ClearChildViewState() protectedDeletes the view-state information for all the server control’s child controls. Inherited from Control.
ClearEffectiveClientIDMode() protectedSets 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() protectedCreates 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) protectedBinds 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() protectedBinds 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) protectedEnds design-time tracing of rendering data. Inherited from Control.
EnsureID() protectedCreates an identifier for controls that do not have an identifier assigned. Inherited from Control.
Equals(Object, Object) staticDetermines 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 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(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(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(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(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.
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)Exports the ASPxTreeList’s data to the specified file in DOCX format, 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(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(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(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(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.
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)Exports the ASPxTreeList’s data to the specified file in PDF format, 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(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(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(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(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.
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)Exports the ASPxTreeList’s data to the specified file in RTF format, and writes it to the response in binary format.
ExportToDocx(Stream, DocxExportOptions)Exports the ASPxTreeList’s data to the specified stream in DOCX format using the specified options.
ExportToDocx(Stream)Exports the ASPxTreeList’s data to the specified file in DOCX format.
ExportToPdf(Stream, PdfExportOptions)Exports the ASPxTreeList’s data to the specified stream in PDF format using the specified options.
ExportToPdf(Stream)Exports the ASPxTreeList’s data to the specified stream in PDF format.
ExportToRtf(Stream, RtfExportOptions)Exports the ASPxTreeList’s data to the specified stream in RTF format using the specified options.
ExportToRtf(Stream)Exports the ASPxTreeList’s data to the stream in RTF format.
ExportToXls(Stream, XlsExportOptions)Exports the control’s data to the specified stream in XLS format.
ExportToXls(Stream)Exports the ASPxTreeList’s data to the specified stream in XLS format.
ExportToXlsx(Stream, XlsxExportOptions)Exports the control’s data to the specified stream in XLSX format.
ExportToXlsx(Stream)Exports the ASPxTreeList’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(XlsExportOptions)Exports the control’s data in XLS format with the specified export settings, and writes it to the response in binary format.
ExportXlsToResponse(Boolean, XlsExportOptions)Exports the control’s data to a 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(String, XlsExportOptions)Exports the control’s data to a file in XLS format with the specified export settings, 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)Exports the ASPxTreeList’s data to the specified file in XLS format, 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(XlsxExportOptions)Exports the control’s data in XLSX format with the specified export settings, and writes it to the response in binary format.
ExportXlsxToResponse(Boolean, XlsxExportOptions)Exports the control’s data to a file in XLSX format with the specified export settings, 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(String, XlsxExportOptions)Exports the control’s data to a file in XLSX format with the specified export settings, 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)Exports the ASPxTreeList’s data to the specified file in XLSX format, and writes it to the response in binary format.
FindControl(String, Int32) protectedSearches 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.
FindControl(String)Searches the current naming container for a server control with the specified id parameter. 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() staticObtains 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() protectedGets design-time data for a control. Inherited from Control.
GetHashCode()Serves as the default hash function. Inherited from Object.
GetResourceUrl(Page, String) staticReturns a URL reference to an embedded resource in an assembly. Inherited from ASPxWebControl.
GetResourceUrl(Page, Type, String) staticReturns 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(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.
GetRouteUrl(RouteValueDictionary)Gets the URL that corresponds to a set of route parameters. 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() protectedReturns a value indicating whether events are registered for the control or any child controls. Inherited from Control.
HideFilterControl()Hides the Filter Control.
HtmlEncode(String, Boolean)For internal use only. Inherited from ASPxWebControl.
HtmlEncode(String)For internal use only. Inherited from ASPxWebControl.
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() protectedDetermines 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) protectedRestores control-state information from a previous page request that was saved by the SaveControlState() method. Inherited from Control.
MakeResponseCompressed() staticSpecifies 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) staticSpecifies 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) protectedRetrieves the physical path that a virtual path, either absolute or relative, maps to. Inherited from Control.
MemberwiseClone() protectedCreates 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) protectedDetermines whether the event for the server control is passed up the page’s UI server control hierarchy. Inherited from Control.
OnDataBinding(EventArgs) protectedRaises the DataBinding event. Inherited from Control.
OnUnload(EventArgs) protectedRaises the Unload event. Inherited from Control.
OpenFile(String) protectedGets a Stream used to read a file. Inherited from Control.
RaiseBubbleEvent(Object, EventArgs) protectedAssigns any sources of the event and its information to the control’s parent. Inherited from Control.
RedirectOnCallback(String) staticRedirects a client to a new URL while processing a callback. Inherited from ASPxWebControl.
ReferenceEquals(Object, Object) staticDetermines 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, Boolean) staticRegisters base scripts required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl.
RegisterBaseScript(Page) staticRegisters base scripts, required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl.
RegisterStyleSheets()For internal use only.
RegisterUtilsScript(Page) staticObsolete. Registers utils scripts required to embed an ASPxWebControl control onto the specified page. Inherited from ASPxWebControl.
RemovedControl(Control) protectedCalled 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) protectedOutputs 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) protectedRenders the contents of the control to the specified writer. This method is used primarily by control developers. Inherited from WebControl.
RenderControl(HtmlTextWriter, ControlAdapter) protectedOutputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. Inherited from Control.
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.
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() staticSpecifies whether client library registration is required. Inherited from ASPxWebControl.
ResolveAdapter() protectedGets 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() protectedSaves 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) staticSpecifies 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.
SetDesignModeState(IDictionary) protectedSets design-time data for a control. Inherited from Control.
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, 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.
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.
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.
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.
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.

Events

NameDescription
AutoFilterCellEditorCreateEnables you to assign editors to individual filter row cells.
AutoFilterCellEditorInitializeEnables the cell editors displayed within the auto filter row cells to be initialized.
BatchUpdateOccurs after an end-user clicks the Update button in batch edit mode and allows you to provide a custom data updating mechanism.
BeforeExportOccurs before the tree list content is exported.
BeforeGetCallbackResultOccurs after a callback sent by the current control has been processed on the server, but prior to the time the respective callback result render is formed.
BeforeHeaderFilterFillItemsAllows you to populate the header filter dropdown with custom items instead of default items.
CallbackError staticAllows you to handle any server exception that might occur during server-side processing of a callback sent by a DevExpress web control. Inherited from ASPxWebControl.
CancelNodeEditingEnables you to prevent changes made within a node from being discarded.
CellEditorInitializeEnables initializing the cell editors displayed within the edit cells.
ClientLayoutEnables you to save and restore the previously saved layout of the ASPxTreeList.
CommandColumnButtonInitializeEnables individual command buttons to be initialized.
CustomButtonCallbackOccurs when a user clicks a custom command button.
CustomCallbackFires when a round trip to the server has been initiated by a call to the client ASPxClientTreeList.PerformCallback method.
CustomColumnDisplayTextEnables custom display text to be provided for any cell.
CustomDataCallbackFires when a round trip to the server has been initiated by a call to the client ASPxClientTreeList.PerformCustomDataCallback method.
CustomErrorTextEnables you to provide custom error descriptions for exceptions raised during a callback.
CustomFilterExpressionDisplayTextEnables you to display custom text in the filter bar, corresponding to the current filter expression.
CustomFilterNodeEnables you to specify whether the required node should be filtered even if this node doesn’t match the specified filter criteria.
CustomJSPropertiesEnables you to supply any server data that can then be parsed on the client.
CustomNodeSortEnables you to sort data using custom rules.
CustomSummaryCalculateEnables you to calculate summary values manually.
CustomUnboundColumnDataEnables data to be supplied to unbound columns.
DataBindingOccurs when the server control binds to a data source. Inherited from Control.
DataBoundOccurs after the server control is bound to a data source. Inherited from ASPxDataWebControlBase.
DisposedOccurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. Inherited from Control.
EditingOperationCompletedOccurs after data editing has been completed.
ExportRenderBrickEnables rendering of different content from the content exported by default.
FilterControlColumnsCreatedOccurs after all filter control columns have been created.
FilterControlCriteriaValueEditorCreateEnables you to replace the default criteria value editor with a custom one.
FilterControlCriteriaValueEditorInitializeEnables you to initialize the editors displayed within the criteria value.
FilterControlCustomValueDisplayTextEnables you to specify the entered filter value’s custom display text to be displayed when the filter control’s condition value editor is inactive.
FilterControlOperationVisibilityEnables you to dynamically hide operation items (such as the Equals, Contains, etc.) of the filter control’s operation dropdown menu.
FilterControlParseValueEnables you to process and modify an entered value before it is actually accepted by the filter control.
FocusedNodeChangedFires after the focused node has been changed.
HeaderFilterEditorInitializeOccurs when a header filter editor is initialized.
HeaderFilterFillItemsAllows you to add custom header filter items to default items.
HtmlCommandCellPreparedEnables the settings of individual command cells to be changed.
HtmlDataCellPreparedEnables the settings of individual cells to be changed.
HtmlRowPreparedEnables the settings of individual rows to be changed.
InitOccurs when the server control is initialized, which is the first step in its lifecycle. Inherited from Control.
InitNewNodeEnables you to initialize added nodes.
LoadOccurs when the server control is loaded into the Page object. Inherited from Control.
NodeCollapsedFires after a node has been collapsed.
NodeCollapsingFires before a node is collapsed.
NodeDeletedOccurs after a node has been deleted.
NodeDeletingEnables you to prevent a node from being deleted.
NodeExpandedFires after a node has been expanded.
NodeExpandingFires before a node is expanded.
NodeInsertedOccurs after a new node has been added to the ASPxTreeList.
NodeInsertingEnables you to cancel adding a new node.
NodeUpdatedOccurs after a node has been updated.
NodeUpdatingEnables you to prevent a node from being updated.
NodeValidatingEnables you to specify whether node data is valid, and whether the node can be updated.
PageIndexChangedFires after the selected page has been changed.
PageSizeChangedFires on the server side after a page size (amount of rows per a page) is changed by end-user interactions.
ParseValueEnables you to process and modify an entered value before it is actually accepted by the ASPxTreeList.
PreRenderOccurs after the Control object is loaded but prior to rendering. Inherited from Control.
ProcessColumnAutoFilterEnables you to apply custom filter criteria when filter row is in the Auto mode.
ProcessDragNodeFires after a node drag and drop operation has been completed.
ProcessOnClickRowFilterEnables you to apply custom filter criteria when the filter row is in the OnClick mode.
SearchPanelEditorCreateEnables you to replace the default search panel editor with custom one.
SearchPanelEditorInitializeEnables you to customize the properties of an editor displayed within the search panel.
SelectionChangedFires after an end user changed selection.
StartNodeEditingEnables you to prevent a node from being edited.
ToolbarItemClickFires after a toolbar item has been clicked.
UnloadOccurs when the server control is unloaded from memory. Inherited from Control.
VirtualModeCreateChildrenEnables creation of a list of business objects that correspond to the child nodes owned by the processed node (virtual mode).
VirtualModeNodeCreatedOccurs when the ASPxTreeList functions in Virtual Mode after a node has been created.
VirtualModeNodeCreatingEnables you to initialize nodes in a tree virtual mode.

See Also

ASPxTreeList Class

DevExpress.Web.ASPxTreeList Namespace