Skip to main content

TreeList Members

Displays data as a multi-column tree view. Can be used in either bound or unbound mode. See Tree List for more information.

Constructors

Name Description
TreeList() Initializes a new TreeList class instance.

Fields

Name Description
AutoFilterNodeId Contains a value which specifies the Automatic Filtering Row‘s ID.
DefaultTreeLevelWidth The default value for the TreeList.TreeLevelWidth property.
NewItemNodeId An integer value that specifies the value of the TreeListNode.Id property of the node that represents the New Item Row.

Properties

Name Description
AccessibilityObject Gets the AccessibleObject assigned to the control. Inherited from Control.
AccessibleDefaultActionDescription Gets or sets the default action description of the control for use by accessibility client applications. Inherited from Control.
AccessibleDescription Gets or sets the description of the control used by accessibility client applications. Inherited from Control.
AccessibleName Gets or sets the name of the control used by accessibility client applications. Inherited from Control.
AccessibleRole Gets or sets the accessible role of the control. Inherited from Control.
ActiveEditor Gets the currently active cell editor.
ActiveFilter Retrieves the filtering criteria currently applied to this TreeList.
ActiveFilterCriteria Gets or sets the current filter criteria.
ActiveFilterEnabled Gets or sets whether the filtering functionality is enabled.
ActiveFilterInfo Gets the total filter expression.
ActiveFilterString Gets or sets the total filter expression for the TreeList.
AllNodesCount Returns the total number of nodes within the TreeList.
AllowDrop Gets or sets a value indicating whether the control can accept data that the user drags onto it. Inherited from Control.
AllowTouchGestures Gets or sets whether the EditorContainer allows touch gestures when the app runs on touch-enabled devices. Inherited from EditorContainer.
Anchor Gets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. Inherited from Control.
Appearance Provides access to the properties that control the appearance of the Tree List’s elements.
AppearancePrint Provides access to the properties that specify the appearances of the Tree List’s elements when the Tree List is printed and exported.
AutoFillColumn Gets or sets a column that automatically stretches to occupy all available empty space when the column auto-width functionality is disabled.
AutoFillFieldName Gets or sets a data source field, whose associated Tree List column should automatically resize to occupy all available TreeList space.
AutoScrollOffset Gets or sets where this control is scrolled to in ScrollControlIntoView(Control). Inherited from Control.
AutoSize This property is not relevant for this class. Inherited from Control.
BackColor Gets the background color for the control’s empty space.
BackgroundImage Gets or sets the background image displayed in the control. Inherited from Control.
BackgroundImageLayout Gets or sets the background image layout as defined in the ImageLayout enumeration. Inherited from Control.
BandPanelRowHeight Gets or sets the logical row height of band headers.
Bands Provides access to the root band collection.
BestFitVisibleOnly

Gets or sets a value specifying which nodes take part in calculations when applying best fit to columns. This property is obsolete. Use the TreeListOptionsView.BestFitNodes property instead.

BindingContext Gets or sets the BindingContext for the control. Inherited from Control.
BorderStyle Gets or sets the border style for the Tree List.
Bottom Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container’s client area. Inherited from Control.
Bounds Gets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. Inherited from Control.
CanEnableIme protected Gets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. Inherited from Control.
CanFocus Gets a value indicating whether the control can receive focus. Inherited from Control.
CanRaiseEvents protected Determines if events can be raised on the control. Inherited from Control.
CanSelect Gets a value indicating whether the control can be selected. Inherited from Control.
CanShowEditor Gets a value indicating whether the current cell’s editor can be invoked.
CanShowRowFooterSummary Gets whether group footers are allowed to be displayed.
Caption Gets or sets the caption displayed at the top of the TreeList control.
CaptionHeight Gets or sets the height, in pixels, of the panel at the top of the TreeList control in which the caption is displayed.
Capture Gets or sets a value indicating whether the control has captured the mouse. Inherited from Control.
CausesValidation Gets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus. Inherited from Control.
CheckBoxFieldName Gets or sets the name of the field whose values define the node check states.
CheckForIllegalCrossThreadCalls static Gets or sets a value indicating whether to catch calls on the wrong thread that access a control’s Handle property when an application is being debugged. Inherited from Control.
ChildListFieldName Gets or sets the name of the collection property that returns child items in a bound business object. See Virtual Mode - Binding to a Hierarchical Business Object (Data Source Level) for more information.
ClientRectangle Gets the rectangle that represents the client area of the control. Inherited from Control.
ClientSize Gets or sets the height and width of the client area of the control. Inherited from Control.
ClipboardDataProvider Gets an object that provides data for the clipboard in various formats (plain text, plain unicode text, rich text, CSV, BIFF8, HTML).
ColumnPanelRowHeight Gets or sets the height of the column header panel, in pixels.
Columns Provides access to a Tree List’s column collection.
ColumnsImageList Gets or sets the source of images that can be displayed within column headers and bands.
CompanyName Gets the name of the company or creator of the application containing the control. Inherited from Control.
Container Gets the IContainer that contains the Component. Inherited from Component.
ContainsFocus Gets a value indicating whether the control, or one of its child controls, currently has the input focus. Inherited from Control.
ContextMenu Gets or sets the shortcut menu associated with the control. Inherited from Control.
Controls Gets the collection of controls contained within the control. Inherited from Control.
Created Gets a value indicating whether the control has been created. Inherited from Control.
CreateParams protected Gets the required creation parameters when the control handle is created. Inherited from Control.
Cursor Gets or sets the cursor that is displayed when the mouse pointer is over the TreeList control.
CustomizationForm Gets the object representing the Customization Form.
CustomizationFormBounds Gets or sets the boundaries of the Customization Form.
CustomizationRowCount Obsolete. This property is obsolete. Use the TreeList.CustomizationFormBounds property instead.
DataBindings Gets the data bindings for the control. Inherited from Control.
DataMember Gets or sets a specific list in a data source whose data is displayed by the TreeList control.
DataSource Gets or sets the data source for the current TreeList control.
DefaultBackColor static Gets the default background color of the control. Inherited from Control.
DefaultCursor protected Gets or sets the default cursor for the control. Inherited from Control.
DefaultFont static Gets the default font of the control. Inherited from Control.
DefaultForeColor static Gets the default foreground color of the control. Inherited from Control.
DefaultImeMode protected Gets the default Input Method Editor (IME) mode supported by the control. Inherited from Control.
DefaultMargin protected Gets the space, in pixels, that is specified by default between controls. Inherited from Control.
DefaultMaximumSize protected Gets the length and height, in pixels, that is specified as the default maximum size of a control. Inherited from Control.
DefaultMinimumSize protected Gets the length and height, in pixels, that is specified as the default minimum size of a control. Inherited from Control.
DefaultPadding protected Gets the internal spacing, in pixels, of the contents of a control. Inherited from Control.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisableAccessibility static Gets or sets whether the control’s accessibility feature (providing information on the control’s data to accessibility tools, such as Microsoft Narrator) is disabled.
DisplayRectangle Gets the rectangle that represents the display area of the control. Inherited from Control.
Disposing Gets a value indicating whether the base Control class is in the process of disposing. Inherited from Control.
Dock Gets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. Inherited from Control.
DoubleBuffered protected Gets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. Inherited from Control.
DragExpandDelay Obsolete. Gets or sets the amount of time (in milliseconds) before the node is expanded when another node is dragged over it.
DragNodesMode Obsolete. Gets or sets how end-users can drop nodes.
EditingValue Gets or sets the cell value being edited.
EmptyTreeHtmlTemplate Specifies the default HTML-CSS template for an empty TreeList control.
Enabled Gets or sets a value indicating whether the control can respond to user interaction. Inherited from Control.
EnableDynamicLoading Gets or sets whether a node hierarchy is created dynamically (on node expansion) or all at once on initial loading. This property is in effect in virtual binding mode.
EnableEnhancedScrolling Gets or sets whether the Tree List uses an enhanced scroll mechanism, which only repaints the part of its area that becomes visible after a scroll operation.
EnableImprovedColumnSizing Gets or sets whether the updated column width calculation mechanism is enabled.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
ExternalRepository Gets or sets the external repository of in-place editors. Inherited from EditorContainer.
FilterPanelText Gets the text displayed within the Filter Panel.
FindFilterText Gets the query in the Find Panel.
FindPanelVisible Gets or sets whether the Find Panel is visible.
FixedLineWidth Gets or sets the width of the vertical lines that separate fixed columns from the others.
Focused Gets a value indicating whether the control has input focus. Inherited from Control.
FocusedColumn Gets or sets the focused column.
FocusedNode Gets or sets the focused node.
FocusedValue Returns the focused Tree List cell value.
Font Gets or sets the font of the text displayed by the control. Inherited from Control.
FontHeight protected Gets or sets the height of the font of the control. Inherited from Control.
FooterPanelHeight Gets or sets the height of the Summary Footer.
ForeColor Gets or sets the control’s foreground color. Inherited from EditorContainer.
FormatConditions Gets the collection of style format conditions.
FormatRules Provides access to a collection of conditional formatting rules, which allow you to change the appearance of individual cells or rows based on specific conditions.
GroupButtonSize Obsolete. This property is obsolete. Gets or sets the size of group buttons.
Handle Gets the window handle that the control is bound to. Inherited from Control.
HasChildren Gets a value indicating whether the control contains one or more child controls. Inherited from Control.
HasColumnErrors Indicates whether the focused node or at least a single cell within the focused node has an error assigned.
HasFocus Gets a value indicating whether the Tree List control is focused.
Height Gets or sets the height of the control. Inherited from Control.
HierarchyColumn Gets or sets the column in which tree list nodes display their expand/collapse buttons.
HierarchyColumnIndent Gets the summary node indent in the column displaying node collapse/expand buttons.
HierarchyFieldName Gets the name of a field in the underlying data source whose tree list column displays the node expand/collapse buttons.
HorzScrollStep Gets or sets the offset by which the Tree List is scrolled horizontally when the scrollbar buttons are clicked.
HorzScrollVisibility Gets or sets a value specifying when the horizontal scrollbar should be displayed.
HtmlImages Gets or sets a collection of images that can be embedded in column/band headers and cells using the image tag.
HtmlTemplates A collection of HTML-CSS templates that can be applied to TreeList and Gantt UI elements.
ImageIndexFieldName Gets or sets the name of the field whose values represent select image indexes for corresponding nodes.
ImeMode Gets or sets the Input Method Editor (IME) mode of the control. Inherited from Control.
ImeModeBase protected Gets or sets the IME mode of a control. Inherited from Control.
IndicatorWidth Gets or sets the indicator panel‘s width.
InvokeRequired Gets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. Inherited from Control.
IsAccessible Gets or sets a value indicating whether the control is visible to accessibility applications. Inherited from Control.
IsDesignMode This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EditorContainer.
IsDisposed Gets a value indicating whether the control has been disposed of. Inherited from Control.
IsFindPanelVisible Returns whether or not the Find Panel is currently visible.
IsHandleCreated Gets a value indicating whether the control has a handle associated with it. Inherited from Control.
IsLoading Gets whether the control is being initialized. Inherited from EditorContainer.
IsLookUpMode Gets whether the current Tree List control functions as a part of a TreeListLookUpEdit control.
IsMirrored Gets a value indicating whether the control is mirrored. Inherited from Control.
IsPrinting Gets whether the control is sending data to the print/export engine.
IsPrintingAvailable Gets whether the control can be printed or exported.
IsUnboundMode Obtains the value determining whether the current TreeList control is in unbound mode.
KeyFieldName Gets or sets the name of the key field that uniquely identifies records in the data source.
LayoutEngine Gets a cached instance of the control’s layout engine. Inherited from Control.
LayoutVersion Obsolete. Gets or sets the version of the control’s layout.
Left Gets or sets the distance, in pixels, between the left edge of the control and the left edge of its container’s client area. Inherited from Control.
LeftCoord Gets or sets a value specifying the number of pixels by which the control’s content is scrolled horizontally.
LoadingPanelVisible Gets or sets whether the animated Loading Panel indicating the data load process is displayed.
Location Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. Inherited from Control.
LookAndFeel Inherited from EditorContainer.
Margin Gets or sets the space between controls. Inherited from Control.
MaximumSize Gets or sets the size that is the upper limit that GetPreferredSize(Size) can specify. Inherited from Control.
MenuManager Gets or sets an object that controls the look and feel of the popup menus. Inherited from EditorContainer.
MinimumSize Gets or sets the size that is the lower limit that GetPreferredSize(Size) can specify. Inherited from Control.
MinWidth Gets or sets the minimum allowed width of all the columns in a Tree List.
ModifierKeys static Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. Inherited from Control.
MouseButtons static Gets a value indicating which of the mouse buttons is in a pressed state. Inherited from Control.
MousePosition static Gets the position of the mouse cursor in screen coordinates. Inherited from Control.
MRUFilters Provides access to the TreeList’s most recently used filters.
Name Gets or sets the name of the control. Inherited from Control.
NewItemRowText Gets or sets the text displayed in the New Item Row when it is not focused.
NodeHtmlTemplate Specifies the default HTML-CSS template for nodes.
Nodes Provides access to the collection of the TreeList’s root nodes.
NodesIterator Gets an object that enables you to perform specific operations on a set of nodes.
NonColumnFilterCriteria Gets a CriteriaOperator-based filter applied to the TreeList and not associated with any column.
NonColumnFilterString Gets the text representation of the filter applied to the TreeList and not associated with any column.
OptionsBehavior Provides access to the Tree List’s behavior options.
OptionsClipboard Provides access to the options that control row copy and paste operations.
OptionsCustomization Provides access to a TreeList‘s customization options.
OptionsDragAndDrop Contains options that control the node drag-and-drop functionality.
OptionsEditForm Provides access to options that specify the Edit Form — a modal form used to edit cell values.
OptionsFilter Provides access to the TreeList’s filtering options.
OptionsFind Provides access to settings controlling the behavior and visibility of the Find Panel and its elements.
OptionsHtmlTemplate Contains options that are applied when you use HTML and CSS Templates to render nodes.
OptionsLayout Provides access to options that specify how a control’s layout is stored to and restored from a data store (a stream, xml file or the system registry).
OptionsMenu Provides access to the Tree List’s menu options.
OptionsNavigation Provides access to a TreeList‘s focus navigation options.
OptionsPrint Provides access to options that specify how the control is printed and exported.
OptionsScrollAnnotations Provides access to options specific to scrollbar annotations.
OptionsSelection Provides access to the Tree List’s selection options.
OptionsView Provides access to the Tree List’s display options.
Padding Gets or sets padding within the control. Inherited from Control.
Painter Gets an object that provides the painting functionality of the TreeList control.
Parent Gets or sets the parent container of the control. Inherited from Control.
ParentFieldName Gets or sets the data source field that identifies each record’s parent.
PreferredSize Gets the size of a rectangular area into which the control can fit. Inherited from Control.
PreviewFieldName Gets or sets the name of the field that automatically provides data for preview sections.
PreviewIndent Gets or sets the left horizontal offset of content in preview sections.
PreviewLineCount Gets or sets the number of text lines in preview sections.
ProductName Gets the product name of the assembly containing the control. Inherited from Control.
ProductVersion Gets the version of the assembly containing the control. Inherited from Control.
PropagatingImeMode protected static Gets an object that represents a propagating IME mode. Inherited from Control.
RecreatingHandle Gets a value indicating whether the control is currently re-creating its handle. Inherited from Control.
Region Gets or sets the window region associated with the control. Inherited from Control.
RenderRightToLeft protected This property is now obsolete. Inherited from Control.
RepositoryItems Provides access to the control’s internal repository of in-place editors. Inherited from EditorContainer.
ResizeRedraw protected Gets or sets a value indicating whether the control redraws itself when resized. Inherited from Control.
Right Gets the distance, in pixels, between the right edge of the control and the left edge of its container’s client area. Inherited from Control.
RightToLeft Gets or sets a value indicating whether control’s elements are aligned to support locales using right-to-left fonts. Inherited from Control.
RootValue Gets or sets the value that identifies root records in the data source. The root records must have the RootValue in the field the ParentFieldName property specifies.
RowHeight Gets or sets the height of a node in pixels.
ScaleChildren protected Gets a value that determines the scaling of child controls. Inherited from Control.
ScaleFactor This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EditorContainer.
SelectedHtmlText
SelectImageList Gets or sets the source of select images for nodes.
Selection Gets the collection of selected nodes.
ShowButtonMode Gets or sets a value that specifies which column cells display editor buttons.
ShowFocusCues protected Gets a value indicating whether the control should display focus rectangles. Inherited from Control.
ShowKeyboardCues protected Gets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. Inherited from Control.
Site Gets or sets the site of the control. Inherited from Control.
Size Gets or sets the height and width of the control. Inherited from Control.
SortedColumnCount Gets the number of columns involved in sorting.
State Gets the control’s current state.
StateImageList Gets or sets the source of state images for nodes.
SyncCheckStateWithSourceOnChecking This member supports the internal infrastructure.
TabIndex Gets or sets the tab order of the control within its container. Inherited from Control.
TabStop Gets or sets a value indicating whether the user can give the focus to this control using the TAB key. Inherited from Control.
Tag Gets or sets the object that contains data about the control. Inherited from Control.
Text Gets or sets the control’s text. Inherited from EditorContainer.
ToolTipController Gets or sets the component that controls the behavior and appearance of hints displayed for a container control’s visual elements. Inherited from EditorContainer.
Top Gets or sets the distance, in pixels, between the top edge of the control and the top edge of its container’s client area. Inherited from Control.
TopLevelControl Gets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in. Inherited from Control.
TopVisibleNodeIndex Gets or sets the index of the top visible node.
TopVisibleNodePixel Gets or sets the vertical scroll position of the top node.
TreeLevelWidth Gets or sets the width of the level indents.
TreeLineStyle Gets or sets the style (solid, dash, etc.) of lines indicating the node hierarchy in the row indent area. This property is obsolete, use TreeListOptionsView.TreeLineStyle instead.
TreeListDisposing Gets a value indicating whether the current TreeList control is being unloaded from memory.
TreeViewColumn Gets or sets the only column whose values are displayed by the control in TreeView visual style.
TreeViewFieldName Gets or sets the only field whose values are displayed by the control in TreeView visual style.
UpdateTopVisibleNodeIndexOnCollapse This member supports the internal infrastructure, and is not intended to be used directly from your code.
UseAdvancedCustomizationForm static Gets or sets whether to use the advanced Customization Form.
UseDirectXPaint Gets or sets whether the DirectX Hardware Acceleration is enabled for this Tree List control.
UseDisabledStatePainter Gets or sets whether the control is painted grayed out, when it’s in the disabled state.
UseWaitCursor Gets or sets a value indicating whether to use the wait cursor for the current control and all child controls. Inherited from Control.
VertScrollVisibility Gets or sets a value specifying when the Tree List’s vertical scrollbar is visible.
ViewInfo Gets the control’s view/display information.
ViewStyle Gets or sets whether the control renders its data in a default Tree List style (cell borders, column headers and indicator panel are visible by default) or Tree View style (no cell borders, column headers and indicator panel).
Visible Gets or sets a value indicating whether the control and all its child controls are displayed. Inherited from Control.
VisibleColumnCount Obsolete. Gets the number of visible columns within the Tree List.
VisibleColumns Gets the collection of visible columns.
VisibleNodesCount Gets the number of rows which are not hidden within collapsed groups.
Width Gets or sets the width of the control. Inherited from Control.
WindowTarget This property is not relevant for this class. Inherited from Control.

Methods

Name Description
About() static Brings up the About dialog.
AccessibilityNotifyClients(AccessibleEvents, Int32, Int32) protected Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control . Inherited from Control.
AccessibilityNotifyClients(AccessibleEvents, Int32) protected Notifies the accessibility client applications of the specified AccessibleEvents for the specified child control. Inherited from Control.
AccessibleNotifyClients(AccessibleEvents, BaseAccessible) Notifies accessibility client applications of the specified AccessibleEvents event for the specified child control.
AccessibleNotifyClients(AccessibleEvents, Int32, Int32) Notifies accessibility client applications of the specified AccessibleEvents event for the specified child control.
AddFilter(CriteriaOperator) Adds a CriteriaOperator-based filter to the current TreeList.
AddFilter(String) Adds a predefined filter with a string filtering condition to the current TreeList.
AppendNode(Object, TreeListNode, Object) Adds a TreeListNode containing the specified values to the XtraTreeList.
AppendNode(Object, TreeListNode, CheckState, NodeCheckBoxStyle, Object) Adds a TreeListNode that contains the specified values to the XtraTreeList.
AppendNode(Object, TreeListNode, CheckState, Object) Adds a TreeListNode containing the specified values to the XtraTreeList.
AppendNode(Object, TreeListNode, CheckState) Appends a new node with the specified settings.
AppendNode(Object, TreeListNode) Adds a new TreeListNode containing the specified values to the XtraTreeList.
AppendNode(Object, Int32, Int32, Int32, Int32, Object) Adds a TreeListNode containing the specified values to the XtraTreeList.
AppendNode(Object, Int32, Int32, Int32, Int32, CheckState, NodeCheckBoxStyle, Object) Adds a TreeListNode that contains the specified values to the XtraTreeList.
AppendNode(Object, Int32, Int32, Int32, Int32, CheckState, Object) Adds a TreeListNode containing the specified values to the XtraTreeList.
AppendNode(Object, Int32, Int32, Int32, Int32, CheckState) Appends a new node with the specified settings.
AppendNode(Object, Int32, Int32, Int32, Int32) Appends a new node with the specified settings.
AppendNode(Object, Int32, Object) Adds a TreeListNode containing the specified values to the XtraTreeList.
AppendNode(Object, Int32, CheckState, Object) Adds a TreeListNode containing the specified values to the XtraTreeList.
AppendNode(Object, Int32, CheckState) Appends a new node with the specified settings.
AppendNode(Object, Int32) Appends a new node containing the specified values to the specified node’s child collection.
ApplyFindFilter(String) Fills in the Find Panel with the specified query and applies it.
BeginDelete() Prevents deletion updates until the TreeList.EndDelete method is called.
BeginInit() Notifies the control that the initialization has started. Inherited from EditorContainer.
BeginInvoke(Delegate, Object[]) Executes the specified delegate asynchronously with the specified arguments, on the thread that the control’s underlying handle was created on. Inherited from Control.
BeginInvoke(Delegate) Executes the specified delegate asynchronously on the thread that the control’s underlying handle was created on. Inherited from Control.
BeginSelection() Prevents selection updates until the TreeList.EndSelection method is called.
BeginSort() Prevents the tree structure from being changed when changing specific options affecting the order of nodes, until the TreeList.EndSort method is called.
BeginUnboundLoad()

In unbound mode, prevents updates of the tree structure due to adding, deleting and modifying nodes, until the TreeList.EndUnboundLoad method is called.

BeginUpdate() Locks the TreeList, preventing visual updates of the object and its elements until the EndUpdate or CancelUpdate method is called.
BestFitColumns() Modifies the width of each visible column so that the contents of its cells are not truncated, if possible.
BestFitColumns(Boolean) Modifies the width of each visible column so that the contents of its cells are not truncated, if possible. Allows you to resize columns to fit the treelist width.
BindCommand(Expression<Action>, Object, String, Func<Object>)
BindCommand(Object, String, Func<Object>)
BindCommand<T>(Expression<Action<T>>, Object, String, Func<T>)
BringToFront() Brings the control to the front of the z-order. Inherited from Control.
CalcHitInfo(Point) Returns information about the Tree List’s elements which are located at the specified point.
CancelCurrentEdit() Cancels changes made to focused node cells.
CancelSort() Unlocks control redrawing after it has been locked by the TreeList.BeginSort method, without causing an immediate visual update.
CancelUpdate() Unlocks the TreeList object after it has been locked by the BeginUpdate method, without causing an immediate visual update.
CanFilterColumn(TreeListColumn) Gets whether or not the Tree List data can be filtered by the specific column’s data.
CanIndentNodes(IEnumerable<TreeListNode>) For internal use.
CanOutdentNodes(IEnumerable<TreeListNode>) For internal use.
CanSortColumn(TreeListColumn) Gets whether or not the specific TreeListColumn can be sorted.
CheckActiveEditor(Control) static Returns whether the EditorContainer descendant is active. Inherited from EditorContainer.
CheckAll() Checks all TreeList nodes.
ClearColumnErrors() Removes the error descriptions for a focused node.
ClearColumnFilter(TreeListColumn) Removes the filter condition applied to the specified column.
ClearColumnsFilter() Removes the filter criteria applied to the TreeList.
ClearDocument() Clears a print/export document.
ClearFindFilter() Discards the query in the Find Panel.
ClearFocusedColumn() Removes focus from the focused column.
ClearNodes() Removes all nodes from the XtraTreeList.
ClearSelection() Unselects all nodes, and removes them from the TreeList.Selection collection.
ClearSorting() Clears all the sorting that has been applied to an Tree List control.
CloseEditForm() Closes the Edit Form.
CloseEditor() Hides the active editor, saving changes that were made.
CollapseAll() Collapses all the nodes in the Tree List.
CollapseToLevel(Int32) Collapses all nodes at the specified and subsequent levels.
Contains(Control) Retrieves a value indicating whether the specified control is a child of the control. Inherited from Control.
ConvertFormatConditionToFormatRules() Converts objects from the TreeList.FormatConditions collection to TreeListFormatRule objects and adds them to the TreeList.FormatRules collection.
CopyNode(TreeListNode, TreeListNode, Boolean, Int32) Copies the specified node to the specified position in the collection of child nodes of another node. Use this method in unbound mode.
CopyNode(TreeListNode, TreeListNode, Boolean) Copies the specified node to the specified node’s child collection. This method does not update the data source and is intended for use in unbound mode.
CopyNodes(IEnumerable<TreeListNode>, TreeListNode, Boolean, Int32) Copies the specified nodes to the specified position in the collection of child nodes of another node. Use this method in unbound mode.
CopyToClipboard() Copies selected nodes to the Clipboard.
CreateControl() Forces the creation of the visible control, including the creation of the handle and any visible child controls. Inherited from Control.
CreateControlsInstance() protected Creates a new instance of the control collection for the control. Inherited from Control.
CreateCustomization() Obsolete. Invokes the Customization Form.
CreateGraphics() Creates the Graphics for the control. Inherited from Control.
CreateGraphicsCache() Initializes a GraphicsCache object for this TreeList. GraphicsCache objects provide an API that you should use instead of the standard Graphics class API to custom paint a TreeList when it has the DirectX Hardware Acceleration enabled.
CreateHandle() protected Creates a handle for the control. Inherited from Control.
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
DefWndProc(Message) protected Sends the specified message to the default window procedure. Inherited from Control.
DeleteNode(TreeListNode) Removes a specific TreeListNode from the XtraTreeList.
DeleteNodes(IEnumerable<TreeListNode>) Deletes the specified nodes.
DeleteSelectedNodes() Deletes the selected nodes in multiple selection mode or focused nodes in single selection mode.
DestroyHandle() protected Destroys the handle associated with the control. Inherited from Control.
Dispose() Releases all resources used by the Component. Inherited from Component.
DoDragDrop(Object, DragDropEffects) Begins a drag-and-drop operation. Inherited from Control.
DoDragDropNode(TreeListNode, DragDropEffects) Allows you to implement drag-and-drop operations between controls on tree list nodes. Begins a drag-and-drop operation, and forces the tree list and target control to raise the events relative to the operation.
DoDragDropNodes(IEnumerable<TreeListNode>, DragDropEffects) Allows you to implement drag-and-drop operations between controls on tree list nodes. Begins a drag-and-drop operation, and forces the tree list and target control to raise the events relative to the operation.
DoIncrementalSearch(Boolean) Continues the incremental search that is in progress in the specified direction.
DrawToBitmap(Bitmap, Rectangle) Supports rendering to the specified bitmap. Inherited from Control.
EndCurrentEdit() Posts the focused node’s values to the data source. Set the EndCurrentEdit(System.Boolean) parameter to true to re-sort and re-filter the tree after saving changes.
EndCurrentEdit(Boolean) Posts the focused node’s values to the data source and optionally re-sorts and re-filters the tree.
EndDelete() Enables deletion updates after calling the TreeList.BeginDelete method and forces an immediate update.
EndInit() Notifies the control that the initialization has been completed. Inherited from EditorContainer.
EndInvoke(IAsyncResult) Retrieves the return value of the asynchronous operation represented by the IAsyncResult passed. Inherited from Control.
EndSelection() Enables selection updates after calling the TreeList.BeginSelection method and forces an immediate update.
EndSort() Forces the control to update itself after the TreeList.BeginSort method has been called.
EndUnboundLoad() Forces the control to update itself after the TreeList.BeginUnboundLoad method has been called.
EndUpdate() Unlocks the TreeList object after a call to the BeginUpdate method and causes an immediate visual update.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
ExpandAll() Expands all Tree List nodes.
ExpandToLevel(Int32) Expands nodes up to the specified level.
ExportToCsv(Stream, CsvExportOptions) Exports the control’s data to the specified stream in CSV format using the specified options.
ExportToCsv(Stream) Exports data to the specified stream in CSV format.
ExportToCsv(String, CsvExportOptions) Exports the control’s data to the specified file in CSV format using the specified options.
ExportToCsv(String) Exports the Tree List’s data to the specified CSV file.
ExportToDocx(Stream, DocxExportOptions) Exports the control’s data in the Office Open XML format (DOCX file) and sends it to the specified stream.
ExportToDocx(Stream) Exports the control’s data in the Office Open XML file format (DOCX file) and sends it to the specified stream.
ExportToDocx(String, DocxExportOptions) Exports the control’s data in the Office Open XML format and saves it to the specified DOCX file.
ExportToDocx(String) Exports the control’s data in the Office Open XML file format and saves it to the specified DOCX file.
ExportToHtml(Stream, HtmlExportOptions) Exports the control’s data to the specified stream in HTML format using the specified options.
ExportToHtml(Stream) Exports the Tree List’s data as HTML and sends it to the specified stream.
ExportToHtml(String, HtmlExportOptions) Exports the control’s data to the specified file in HTML format using the specified options.
ExportToHtml(String) Exports the Tree List’s data to the specified file as HTML.
ExportToMht(Stream, MhtExportOptions) Exports the control’s data to the specified stream in MHT format using the specified options.
ExportToMht(Stream, String, String, Boolean) Obsolete. Exports the control’s data to a stream in MHT format using the specified character encoding, with the specified title. The output file can be compressed (secondary characters e.g. spaces are removed) if required.
ExportToMht(String, MhtExportOptions) Exports the control’s data to the specified file in MHT format using the specified options.
ExportToMht(String, String, String, Boolean) Obsolete. Exports the control’s data to a file in MHT format using the specified character encoding, with the specified title. The output file can be compressed (secondary characters e.g. spaces are removed) if required.
ExportToMht(String, String) Obsolete. Exports the control’s data to a file in MHT format using the specified character encoding.
ExportToPdf(Stream, PdfExportOptions) Exports the control’s data to the specified stream in PDF format using the specified options.
ExportToPdf(Stream) Exports the Tree List’s data to a PDF document and sends it to the specified stream.
ExportToPdf(String, PdfExportOptions) Exports the control’s data to the specified file in PDF format using the specified options.
ExportToPdf(String) Exports the Tree List’s data to the specified PDF file.
ExportToRtf(Stream) Exports the Tree List’s data as Rich Text and sends it to the specified stream.
ExportToRtf(String) Exports the Tree List’s data to the specified RTF file.
ExportToText(Stream, TextExportOptions) Exports the control’s data to the specified stream in Text format using the specified options.
ExportToText(Stream) Exports the Tree List’s data to a text document and sends it to the specified stream.
ExportToText(String, TextExportOptions) Exports the control’s data to the specified file in Text format using the specified options.
ExportToText(String) Exports the Tree List’s data to a text file at the specified path.
ExportToXls(Stream, XlsExportOptions) Exports the control’s data to the specified stream in XLS format using the specified options.
ExportToXls(Stream) Exports the Tree List’s data as XLS and sends it to the specified stream.
ExportToXls(String, XlsExportOptions) Exports the control’s data to the specified file in XLS format using the specified options.
ExportToXls(String) Exports the Tree List’s data to the specified file as XLS.
ExportToXlsx(Stream, XlsxExportOptions) Exports data to the specified stream in XLSX (MS Excel 2007) format using the specified options.
ExportToXlsx(Stream) Exports data to the specified stream in XLSX (MS Excel 2007) format.
ExportToXlsx(String, XlsxExportOptions) Exports data to a file in XLSX (MS Excel 2007) format using the specified options.
ExportToXlsx(String) Exports data to the specified file in XLSX (MS Excel 2007) format.
ExportToXml(Stream) Exports the Tree List’s data as XML and sends it to the specified stream.
ExportToXml(String) Exports the Tree List’s data to the specified file as XML.
FilterNodes() Forces the Tree List control to re-filter its data.
FilterNodes(TreeListNodes) Forces data filtering for the specified node collection.
FindForm() Retrieves the form that the control is on. Inherited from Control.
FindNode(Predicate<TreeListNode>) Returns the first node that matches the specified criteria.
FindNodeByFieldValue(String, Object) Returns a node by its field value.
FindNodeByID(Int32) Returns the node specified by its identifier.
FindNodeByKeyID(Object) Returns the node by its key field value.
FindNodes(Predicate<TreeListNode>) Returns all nodes that match the specific criteria.
FireChanged() Forces an update to the control’s properties listed within the property grid at design time.
Focus() Sets input focus to the control. Inherited from Control.
FocusNewItemNode() Sets focus to the New Item Row.
ForceInitialize() Forces the Tree List to finish its initialization.
FromChildHandle(IntPtr) static Retrieves the control that contains the specified handle. Inherited from Control.
FromHandle(IntPtr) static Returns the control that is currently associated with the specified handle. Inherited from Control.
FullCollapse() Obsolete. Collapses all expanded nodes within the XtraTreeList.
FullExpand() Obsolete. Expands all nodes within the XtraTreeList.
FullExpandNode(TreeListNode) Obsolete. Expands all child nodes of a specific node.
GetAllCheckedNodes() Returns the list of checked nodes.
GetAutoFilterValue(TreeListColumn) Returns the filtering value of an automatic filtering row cell that belongs to the specific Tree List column.
GetAutoSizeMode() protected Retrieves a value indicating how a control will behave when its AutoSize property is enabled. Inherited from Control.
GetChildAtPoint(Point, GetChildAtPointSkip) Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type. Inherited from Control.
GetChildAtPoint(Point) Retrieves the child control that is located at the specified coordinates. Inherited from Control.
GetColumnByColumnHandle(Int32) Gets the column by the bound field’s index within the data source.
GetColumnByVisibleIndex(Int32) Returns a column by its visible index.
GetColumnError(TreeListColumn) Gets the error description for the focused cell or the entire focused node.
GetColumnErrorType(TreeListColumn) Gets the type of the error associated with the specified cell in the currently focused node.
GetColumnHeaderBestWidth(TreeListColumn) Returns the column header width that allows the content to be displayed in its entirety.
GetContainerControl() Returns the next ContainerControl up the control’s chain of parent controls. Inherited from Control.
GetDataRecordByNode(TreeListNode) Returns a data row associated with the node specified.
GetDataRow(Int32) Returns a DataRow in the bound DataTable that contains data for the specified node.
GetEditorShowMode(TreeListNode) Gets the actual TreeListOptionsBehavior.EditorShowMode property value for this specific node.
GetFocusedDataRow() Returns a DataRow in the bound DataTable that contains data for the focused node.
GetFocusedDisplayText() Returns the display text of the currently focused Tree List cell.
GetFocusedRow() Returns an Object in the bound data source that contains data for the focused node.
GetFocusedRowCellDisplayText(TreeListColumn) Returns the text displayed by a Tree List cell that resides within the currently focused data row.
GetFocusedRowCellDisplayText(String) Returns the string/text displayed in the specified cell in the focused node.
GetFocusedRowCellValue(TreeListColumn) Retrieves the value stored within the required cell of the currently focused row.
GetFocusedRowCellValue(String) Returns the value of the specified cell in the focused node.
GetGroupSummaryValue(TreeListColumn, TreeListNodes) Returns a summary value calculated against the specified group of nodes.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetHitInfo(Point) Obsolete. Returns information on the current TreeList control at a specified point.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetNextControl(Control, Boolean) Retrieves the next control forward or back in the tab order of child controls. Inherited from Control.
GetNodeAt(Point) Returns the Tree List node located under the target coordinates.
GetNodeAt(Int32, Int32) Returns the Tree List node located under the target coordinates.
GetNodeByVisibleIndex(Int32) Returns a node with the specified index among the visible nodes.
GetNodeIndex(TreeListNode) Gets the specified node’s index.
GetNodeList() Returns a list of all nodes in the TreeList.
GetPreferredSize(Size) Retrieves the size of a rectangular area into which a control can be fitted. Inherited from Control.
GetRow(Int32) Returns an Object in the bound data source that contains data for the specified node.
GetRowCellDisplayText(TreeListNode, TreeListColumn) Returns the text displayed by a specific Tree List cell.
GetRowCellDisplayText(TreeListNode, String) Returns the string/text displayed in the specified cell.
GetRowCellValue(TreeListNode, TreeListColumn) Retrieves the value stored within the required cell.
GetRowCellValue(TreeListNode, String) Returns the value of the specified cell.
GetScaledBounds(Rectangle, SizeF, BoundsSpecified) protected Retrieves the bounds within which the control is scaled. Inherited from Control.
GetScrollAnnotations(ScrollAnnotationKind) Returns informaiton on scroll annotations of the specified kind.
GetSelectedCells() Returns the list of currently selected cells.
GetSelectedCells(TreeListNode) Returns the list of columns currently selected in the specified node.
GetService(Type) protected Returns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetSortColumn(Int32) Gets the column involved in sorting by its index within the sort column collection.
GetStyle(ControlStyles) protected Retrieves the value of the specified control style bit for the control. Inherited from Control.
GetSummaryValue(TreeListColumn, Boolean) Returns a summary value calculated against all the Tree List nodes or against the root nodes only.
GetSummaryValue(TreeListColumn) Returns a summary value calculated against all the Tree List nodes or against the root nodes only.
GetToolTipController() Returns the actual tooltip controller that controls the behavior and appearance of hints for the container editor. Inherited from EditorContainer.
GetTopLevel() protected Determines if the control is a top-level control. Inherited from Control.
GetType() Gets the Type of the current instance. Inherited from Object.
GetVisibleIndexByNode(TreeListNode) Returns the index of the specified node among the visible nodes.
Hide() Conceals the control from the user. Inherited from Control.
HideCustomization() Closes the Customization Form.
HideEditor() Switches the TreeList control from edit to browse mode without saving changes.
HideFindPanel() Hides the Find Panel.
HideLoadingPanel() Hides the animated Loading Panel indicating the data load process.
ImportFromXml(Stream) Imports the data to the Tree List from the specified stream.
ImportFromXml(String) Imports the data to the Tree List from the XML file.
IndentNodes(IEnumerable<TreeListNode>, Boolean) For internal use.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
InitLayout() protected Called after the control has been added to another container. Inherited from Control.
InternalGetService(Type) This method supports the internal infrastructure and is not intended to be called directly from your code.
Invalidate() Invalidates the entire surface of the control and causes the control to be redrawn. Inherited from Control.
Invalidate(Boolean) Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. Inherited from Control.
Invalidate(Rectangle, Boolean) Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. Inherited from Control.
Invalidate(Rectangle) Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Inherited from Control.
Invalidate(Region, Boolean) Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. Inherited from Control.
Invalidate(Region) Invalidates the specified region of the control (adds it to the control’s update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Inherited from Control.
InvalidateBand(TreeListBand) Invalidates the specified band header.
InvalidateBandPanel() Invalidates the band panel.
InvalidateCell(TreeListNode, TreeListColumn) Invalidates the specified cell.
InvalidateColumnHeader(TreeListColumn) Invalidates the header of the specified column.
InvalidateColumnPanel() Invalidates the column header panel.
InvalidateFilterPanel() Invalidates the Filter Panel.
InvalidateNode(TreeListNode) Invalidates the specified node.
InvalidateNodes() Invalidates all visible nodes and row footers.
InvalidateRow(RowInfo) Invalidates the node that corresponds to the specified view information.
InvalidateRowPreview(TreeListNode) Invalidates the preview section in the specified node.
InvalidateScrollAnnotations() Invalidates scrollbar annotations, and causes them to be redrawn.
InvalidateSummaryFooterPanel() Invalidates the summary footer panel.
Invoke(Delegate, Object[]) Executes the specified delegate, on the thread that owns the control’s underlying window handle, with the specified list of arguments. Inherited from Control.
Invoke(Delegate) Executes the specified delegate on the thread that owns the control’s underlying window handle. Inherited from Control.
InvokeGotFocus(Control, EventArgs) protected Raises the GotFocus event for the specified control. Inherited from Control.
InvokeLostFocus(Control, EventArgs) protected Raises the LostFocus event for the specified control. Inherited from Control.
InvokeMenuItemClick(TreeListMenuItemClickEventArgs) This member supports the Tree List’s infrastructure and should not be used from your code.
InvokeOnClick(Control, EventArgs) protected Raises the Click event for the specified control. Inherited from Control.
InvokePaint(Control, PaintEventArgs) protected Raises the Paint event for the specified control. Inherited from Control.
InvokePaintBackground(Control, PaintEventArgs) protected Raises the PaintBackground event for the specified control. Inherited from Control.
IsAutoFilterNode(TreeListNode) Gets whether the specified node is an Automatic Filtering Row.
IsCellSelected(TreeListNode, TreeListColumn) Returns whether the cell in the specified node and column is currently selected.
IsColumnAllowFilterEditor(TreeListColumn) Checks whether or not the Filter Editor dialog is available for the specific Tree List column.
IsKeyLocked(Keys) static Determines whether the CAPS LOCK, NUM LOCK, or SCROLL LOCK key is in effect. Inherited from Control.
IsMnemonic(Char, String) static Determines if the specified character is the mnemonic character assigned to the control in the specified string. Inherited from Control.
IsNewItemRow(TreeListNode) Identifies whether the specified node is the New Item Row.
IsNodeVisible(TreeListNode) static Indicates whether a specific TreeListNode is currently visible.
IsRootNode(TreeListNode) Returns whether the specified node is a root node.
LayoutChanged() Called when global changes are applied to the TreeList object.
LockReloadNodes() In bound mode, prevents updates of the tree structure when adding and deleting nodes and changing nodes’ parents via the Tree List or data source, until the TreeList.UnlockReloadNodes method is called.
MakeColumnVisible(TreeListColumn) Scrolls the control’s content so that the specified column becomes visible on screen.
MakeNodeVisible(TreeListNode) Makes visible the TreeListNode specified via the parameter.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
MoveFirst() Moves focus to the first node.
MoveLast() Moves focus to the last node within the current TreeList.
MoveLastVisible() Moves focus to the last visible node within the current TreeList.
MoveNext() Moves focus to the node following the currently focused one, while expanding collapsed nodes, when required.
MoveNextVisible() Moves focus to the next visible node following the currently focused one.
MoveNode(TreeListNode, TreeListNode, Boolean, Int32) Moves the TreeListNode specified via the sourceNode parameter to the TreeListNode.Nodes collection of the TreeListNode specified by the destinationNode parameter.
MoveNode(TreeListNode, TreeListNode, Boolean) Moves the selected node to the specified node’s child collection.
MoveNode(TreeListNode, TreeListNode) Moves the TreeListNode specified via the sourceNode parameter to the TreeListNode.Nodes collection of the TreeListNode specified by the destinationNode parameter.
MoveNodes(IEnumerable<TreeListNode>, TreeListNode, Boolean, Int32) Moves the TreeListNode objects specified via the sourceNodes parameter to the TreeListNode.Nodes collection of the TreeListNode specified by the destinationNode parameter.
MovePrev() Moves focus to the node that precedes the currently focused one, while expanding collapsed nodes, when required.
MovePrevVisible() Moves focus to the visible node preceding the currently focused one.
MoveToNextScrollAnnotation(ScrollAnnotationKind) Moves the focus to the next node with a scrollbar annotation of the specified kind.
MoveToParent() Moves the node focus to the parent node of the currently focused node.
MoveToPrevScrollAnnotation(ScrollAnnotationKind) Moves the focus to the previous node with a scrollbar annotation of the specified kind.
NotifyInvalidate(Rectangle) protected Raises the Invalidated event with a specified region of the control to invalidate. Inherited from Control.
OnAutoSizeChanged(EventArgs) protected Raises the AutoSizeChanged event. Inherited from Control.
OnBackColorChanged(EventArgs) protected Raises the BackColorChanged event. Inherited from Control.
OnBackgroundImageChanged(EventArgs) protected Raises the BackgroundImageChanged event. Inherited from Control.
OnBackgroundImageLayoutChanged(EventArgs) protected Raises the BackgroundImageLayoutChanged event. Inherited from Control.
OnCausesValidationChanged(EventArgs) protected Raises the CausesValidationChanged event. Inherited from Control.
OnChangeUICues(UICuesEventArgs) protected Raises the ChangeUICues event. Inherited from Control.
OnClientSizeChanged(EventArgs) protected Raises the ClientSizeChanged event. Inherited from Control.
OnContextMenuChanged(EventArgs) protected Raises the ContextMenuChanged event. Inherited from Control.
OnContextMenuStripChanged(EventArgs) protected Raises the ContextMenuStripChanged event. Inherited from Control.
OnControlAdded(ControlEventArgs) protected Raises the ControlAdded event. Inherited from Control.
OnControlRemoved(ControlEventArgs) protected Raises the ControlRemoved event. Inherited from Control.
OnCursorChanged(EventArgs) protected Raises the CursorChanged event. Inherited from Control.
OnDockChanged(EventArgs) protected Raises the DockChanged event. Inherited from Control.
OnFontChanged(EventArgs) protected Raises the FontChanged event. Inherited from Control.
OnForeColorChanged(EventArgs) protected Raises the ForeColorChanged event. Inherited from Control.
OnGiveFeedback(GiveFeedbackEventArgs) protected Raises the GiveFeedback event. Inherited from Control.
OnHelpRequested(HelpEventArgs) protected Raises the HelpRequested event. Inherited from Control.
OnImeModeChanged(EventArgs) protected Raises the ImeModeChanged event. Inherited from Control.
OnInvalidated(InvalidateEventArgs) protected Raises the Invalidated event. Inherited from Control.
OnLayout(LayoutEventArgs) protected Raises the Layout event. Inherited from Control.
OnLocationChanged(EventArgs) protected Raises the LocationChanged event. Inherited from Control.
OnMarginChanged(EventArgs) protected Raises the MarginChanged event. Inherited from Control.
OnMouseCaptureChanged(EventArgs) protected Raises the MouseCaptureChanged event. Inherited from Control.
OnMouseHover(EventArgs) protected Raises the MouseHover event. Inherited from Control.
OnMove(EventArgs) protected Raises the Move event. Inherited from Control.
OnNotifyMessage(Message) protected Notifies the control of Windows messages. Inherited from Control.
OnPaddingChanged(EventArgs) protected Raises the PaddingChanged event. Inherited from Control.
OnParentBackColorChanged(EventArgs) protected Raises the BackColorChanged event when the BackColor property value of the control’s container changes. Inherited from Control.
OnParentBackgroundImageChanged(EventArgs) protected Raises the BackgroundImageChanged event when the BackgroundImage property value of the control’s container changes. Inherited from Control.
OnParentBindingContextChanged(EventArgs) protected Raises the BindingContextChanged event when the BindingContext property value of the control’s container changes. Inherited from Control.
OnParentCursorChanged(EventArgs) protected Raises the CursorChanged event. Inherited from Control.
OnParentEnabledChanged(EventArgs) protected Raises the EnabledChanged event when the Enabled property value of the control’s container changes. Inherited from Control.
OnParentFontChanged(EventArgs) protected Raises the FontChanged event when the Font property value of the control’s container changes. Inherited from Control.
OnParentForeColorChanged(EventArgs) protected Raises the ForeColorChanged event when the ForeColor property value of the control’s container changes. Inherited from Control.
OnParentRightToLeftChanged(EventArgs) protected Raises the RightToLeftChanged event when the RightToLeft property value of the control’s container changes. Inherited from Control.
OnParentVisibleChanged(EventArgs) protected Raises the VisibleChanged event when the Visible property value of the control’s container changes. Inherited from Control.
OnPreviewKeyDown(PreviewKeyDownEventArgs) protected Raises the PreviewKeyDown event. Inherited from Control.
OnPrint(PaintEventArgs) protected Raises the Paint event. Inherited from Control.
OnRegionChanged(EventArgs) protected Raises the RegionChanged event. Inherited from Control.
OnSizeChanged(EventArgs) protected Raises the SizeChanged event. Inherited from Control.
OnStyleChanged(EventArgs) protected Raises the StyleChanged event. Inherited from Control.
OnTabIndexChanged(EventArgs) protected Raises the TabIndexChanged event. Inherited from Control.
OnTextChanged(EventArgs) protected Raises the TextChanged event. Inherited from Control.
OutdentNodes(IEnumerable<TreeListNode>, Boolean) For internal use.
PasteFromClipboard() Pastes data from clipboard in the Tree List according to the current ClipboardOptions.PasteMode and TreeListOptionsClipboard.PasteAsChildNodes settings (available from the TreeList.OptionsClipboard object).
PerformLayout() Forces the control to apply layout logic to all its child controls. Inherited from Control.
PerformLayout(Control, String) Forces the control to apply layout logic to all its child controls. Inherited from Control.
PointToClient(Point) Computes the location of the specified screen point into client coordinates. Inherited from Control.
PointToScreen(Point) Computes the location of the specified client point into screen coordinates. Inherited from Control.
PopulateColumns() Creates columns for all public fields in the bound data source.
PostEditor() Posts edited cell’s value to the associated data source.
PreProcessControlMessage(Message) Preprocesses keyboard or input messages within the message loop before they are dispatched. Inherited from Control.
PreProcessMessage(Message) Preprocesses keyboard or input messages within the message loop before they are dispatched. Inherited from Control.
Print() Prints the data displayed in the control.
PrintDialog() Opens the Print dialog that allows a user to print the data displayed in the control.
ProcessCmdKey(Message, Keys) protected Processes a command key. Inherited from Control.
ProcessDialogChar(Char) protected Processes a dialog character. Inherited from Control.
ProcessKeyEventArgs(Message) protected Processes a key message and generates the appropriate control events. Inherited from Control.
ProcessKeyMessage(Message) protected Processes a keyboard message. Inherited from Control.
ProcessKeyPreview(Message) protected Previews a keyboard message. Inherited from Control.
ProcessMnemonic(Char) protected Processes a mnemonic character. Inherited from Control.
RaiseDragEvent(Object, DragEventArgs) protected Raises the appropriate drag event. Inherited from Control.
RaiseKeyEvent(Object, KeyEventArgs) protected Raises the appropriate key event. Inherited from Control.
RaiseMouseEvent(Object, MouseEventArgs) protected Raises the appropriate mouse event. Inherited from Control.
RaisePaintEvent(Object, PaintEventArgs) protected Raises the appropriate paint event. Inherited from Control.
RecreateHandle() protected Forces the re-creation of the handle for the control. Inherited from Control.
RectangleToClient(Rectangle) Computes the size and location of the specified screen rectangle in client coordinates. Inherited from Control.
RectangleToScreen(Rectangle) Computes the size and location of the specified client rectangle in screen coordinates. Inherited from Control.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
ReflectMessage(IntPtr, Message) protected static Reflects the specified message to the control that is bound to the specified handle. Inherited from Control.
Refresh() Forces the Tree List to invalidate its client area and immediately redraw itself.
Refresh(Boolean) Calls the Control.Refresh method, and optionally, clears all automatically calculated node heights.
RefreshCell(TreeListNode, TreeListColumn) Refreshes the specified cell.
RefreshDataSource() Updates the Tree List control to reflect changes made to a data source.
RefreshEditor(Boolean) Refreshes the appearance and value of the active editor.
RefreshNode(TreeListNode) Refreshes the specified node.
RefreshScrollAnnotations(ScrollAnnotationKind, Int32[]) Updates scrollbar annotations of the specified kind for the specified nodes, and causes them to be redrawn.
RefreshScrollAnnotations(ScrollAnnotationKind) Updates scrollbar annotations of the specified kind, and causes them to be redrawn.
ResetAutoFilterCondition(TreeListColumn) Resets the specified column’s auto filter row condition to its default value.
ResetAutoFilterConditions() Resets all columns’ auto filter row conditions to their default values.
ResetAutoFilterConditions(IEnumerable<TreeListColumn>) Resets the specified columns’ auto filter row conditions to their default values.
ResetBackColor() Resets the BackColor property to its default value. Inherited from Control.
ResetBindings() Causes a control bound to the BindingSource to reread all the items in the list and refresh their displayed values. Inherited from Control.
ResetCursor() Resets the Cursor property to its default value. Inherited from Control.
ResetEditorsCache(RepositoryItem) For internal use. Inherited from EditorContainer.
ResetEditorsCache(Type) For internal use. Inherited from EditorContainer.
ResetFont() Resets the Font property to its default value. Inherited from Control.
ResetForeColor() Resets the ForeColor property to its default value. Inherited from Control.
ResetImeMode() Resets the ImeMode property to its default value. Inherited from Control.
ResetMouseEventArgs() protected Resets the control to handle the MouseLeave event. Inherited from Control.
ResetRightToLeft() Resets the RightToLeft property to its default value. Inherited from Control.
ResetText() Resets the Text property to its default value (Empty). Inherited from Control.
RestoreLayoutFromRegistry(String, OptionsLayoutBase) Restores the control’s layout stored at the specified system registry path, using the specified options.
RestoreLayoutFromRegistry(String) Restores the control layout stored at the specified system registry path.
RestoreLayoutFromStream(Stream, OptionsLayoutBase) Loads the control’s layout from a stream, using the specified options.
RestoreLayoutFromStream(Stream) Loads the control’s layout from a stream.
RestoreLayoutFromXml(String, OptionsLayoutBase) Loads a control’s layout from the specified XML file, using the specified options.
RestoreLayoutFromXml(String) Loads a control’s layout from the specified XML file.
ResumeLayout() Resumes usual layout logic. Inherited from Control.
ResumeLayout(Boolean) Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests. Inherited from Control.
RtlTranslateAlignment(ContentAlignment) protected Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text. Inherited from Control.
RtlTranslateAlignment(HorizontalAlignment) protected Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text. Inherited from Control.
RtlTranslateAlignment(LeftRightAlignment) protected Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text. Inherited from Control.
RtlTranslateContent(ContentAlignment) protected Converts the specified ContentAlignment to the appropriate ContentAlignment to support right-to-left text. Inherited from Control.
RtlTranslateHorizontal(HorizontalAlignment) protected Converts the specified HorizontalAlignment to the appropriate HorizontalAlignment to support right-to-left text. Inherited from Control.
RtlTranslateLeftRight(LeftRightAlignment) protected Converts the specified LeftRightAlignment to the appropriate LeftRightAlignment to support right-to-left text. Inherited from Control.
SaveLayoutToRegistry(String, OptionsLayoutBase) Saves the control’s layout to the specified system registry path, using the specified options.
SaveLayoutToRegistry(String) Saves the control’s layout to the specified system registry path.
SaveLayoutToStream(Stream, OptionsLayoutBase) Saves the control’s layout to a stream, using the specified options.
SaveLayoutToStream(Stream) Saves the control’s layout to a stream.
SaveLayoutToXml(String, OptionsLayoutBase) Saves a control’s layout to a specified XML file, using the specified options.
SaveLayoutToXml(String) Saves a control’s layout to a specified XML file.
Scale(SizeF) Scales the control and all child controls by the specified scaling factor. Inherited from Control.
Scale(Single, Single) Scales the entire control and any child controls. Inherited from Control.
Scale(Single) Scales the control and any child controls. Inherited from Control.
ScaleCore(Single, Single) protected This method is not relevant for this class. Inherited from Control.
Select() Activates the control. Inherited from Control.
Select(Boolean, Boolean) protected Activates a child control. Optionally specifies the direction in the tab order to select the control from. Inherited from Control.
SelectAll() Selects all currently visible nodes.
SelectCell(TreeListNode, TreeListColumn) Selects the cell in the specified node and column.
SelectCells(TreeListNode, TreeListColumn, TreeListNode, TreeListColumn) Selects cells in the specified range.
SelectCells(Int32, String, Int32, String) Selects cells in the specified range by data source IDs.
SelectNextControl(Control, Boolean, Boolean, Boolean, Boolean) Activates the next control. Inherited from Control.
SelectNode(TreeListNode) Selects the specified node. This method is in effect only when multi-node selection is available. Otherwise, assign a required node to the FocusedNode property.
SelectNodes(TreeListNode, TreeListNode) Selects nodes in the specified range.
SelectNodes(Int32, Int32) Selects nodes in the specified range by data source IDs.
SendToBack() Sends the control to the back of the z-order. Inherited from Control.
SetAutoFilterValue(TreeListColumn, Object, AutoFilterCondition) Assigns a required value to a automatic filtering row cell owned by a specific Tree List column.
SetAutoSizeMode(AutoSizeMode) protected Sets a value indicating how a control will behave when its AutoSize property is enabled. Inherited from Control.
SetBounds(Int32, Int32, Int32, Int32, BoundsSpecified) Sets the specified bounds of the control to the specified location and size. Inherited from Control.
SetBounds(Int32, Int32, Int32, Int32) Sets the bounds of the control to the specified location and size. Inherited from Control.
SetBoundsCore(Int32, Int32, Int32, Int32, BoundsSpecified) protected Performs the work of setting the specified bounds of this control. Inherited from Control.
SetClientSizeCore(Int32, Int32) protected Sets the size of the client area of the control. Inherited from Control.
SetColumnError(TreeListColumn, String, ErrorType) Sets an error description and an error type for the specified cell within the focused node.
SetColumnError(TreeListColumn, String) Sets an error description for a cell within the focused node or for the entire focused node.
SetColumnPosition(TreeListColumn, Int32, Int32) Moves the specified column to the specified position among visible columns belonging to the same band.
SetDefaultBehaviorOptions() Sets the options provided by the TreeList.OptionsBehavior property to their default values.
SetDefaultCustomizationOptions() Sets the options provided by the TreeList.OptionsCustomization property to their default values.
SetDefaultNavigationOptions() Sets the options provided by the TreeList.OptionsNavigation property to their default values.
SetDefaultOptionsView() Sets the options provided by the TreeList.OptionsView property to their default values.
SetDefaultPrintOptions() Sets the options provided by the TreeList.OptionsPrint property to their default values.
SetDefaultRowHeight() Activates automatic row height adjustment.
SetDefaultSelectionOptions() Sets the options provided by the TreeList.OptionsSelection property to their default values.
SetFocusedNode(TreeListNode) Sets focus to a specific node within the current TreeList control.
SetFocusedRowCellValue(TreeListColumn, Object) Assigns a value to the specified column within the currently focused data row.
SetFocusedRowCellValue(String, Object) Assigns the required value to a cell within the focused Tree List node.
SetFocusedValue(Object) Assigns the required value to the focused Tree List cell.
SetNodeCheckState(TreeListNode, CheckState, Boolean) Sets the node’s check state. Allows you to set the check state for child and parent (if all child nodes are checked or unchecked) nodes.
SetNodeCheckState(TreeListNode, CheckState) Sets the node’s check state to the specified value.
SetNodeIndex(TreeListNode, Int32) Moves the specified node to a new position within its parent node’s child collection.
SetRowCellValue(TreeListNode, TreeListColumn, Object) Sets the TreeList cell to a specific value.
SetRowCellValue(TreeListNode, String, Object) Sets the TreeList cell to a specific value.
SetSearchControl(ISearchControl) This member supports the internal infrastructure, and is not intended to be used directly from your code.
SetSelectionAnchor(TreeListNode, TreeListColumn) When users select multiple nodes, the selection starts from the selection anchor, rather than the currently focused node. Call the SetSelectionAnchor method to set this selection anchor.
SetStyle(ControlStyles, Boolean) protected Sets a specified ControlStyles flag to either true or false. Inherited from Control.
SetTopLevel(Boolean) protected Sets the control as the top-level control. Inherited from Control.
SetVisibleCore(Boolean) protected Sets the control to the specified visible state. Inherited from Control.
Show() Displays the control to the user. Inherited from Control.
ShowAutoFilterConditionsMenu(TreeListColumn) Invokes the condition selector’s menu for the specific column in the automatic filtering row.
ShowContextMenu() Displays a node context menu for the focused cell.
ShowCustomization() Displays the Customization Form.
ShowCustomization(Point) Displays the Customization Form at the specified point.
ShowEditForm(TreeListNode) Opens the Edit Form for the specific Tree List node. If the node parameter is not set, the Edit Form opens for the currently focused node.
ShowEditor() Switches the TreeList control to edit mode.
ShowEditor(String) Moves focus to the specified cell in the focused node and switches the TreeList control to edit mode (activates the cell’s editor).
ShowFilterEditor(TreeListColumn) Shows the Filter Editor.
ShowFilterPopup(TreeListColumn) Shows the filter pop-up menu for the specified column.
ShowFindPanel() Displays the Find Panel.
ShowLoadingPanel() Shows the animated Loading Panel indicating the data load process.
ShowPrintPreview() Opens the Print Preview window, which displays commands in bars.
ShowRibbonPrintPreview() Opens the Print Preview window, which displays commands in a ribbon.
ShowUnboundExpressionEditor(TreeListColumn) Invokes an Expression Editor that enables editing an expression for the specified unbound column.
SizeFromClientSize(Size) protected Determines the size of the entire control from the height and width of its client area. Inherited from Control.
Sort(TreeListNode, TreeListColumn, SortOrder, Boolean) Sorts the specified node’s children against a column. Allows you to sort root nodes.
Sort(TreeListNode, IComparer<TreeListNode>, Boolean) Sorts the specified node’s children using the specified IComparer object. Allows you to sort root nodes.
StartIncrementalSearch(String) Starts an incremental search for the specified string.
StopIncrementalSearch() Stops the incremental search, if there is one currently in progress.
SuspendLayout() Temporarily suspends the layout logic for the control. Inherited from Control.
IDropTarget.OnDragDrop(DragEventArgs) Raises the DragDrop event. Inherited from Control.
IDropTarget.OnDragEnter(DragEventArgs) Raises the DragEnter event. Inherited from Control.
IDropTarget.OnDragLeave(EventArgs) Raises the DragLeave event. Inherited from Control.
IDropTarget.OnDragOver(DragEventArgs) Raises the DragOver event. Inherited from Control.
ToString() Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.
UncheckAll() Unchecks all nodes in the Tree List control.
UnlockReloadNodes() Updates the control’s tree structure after the TreeList.LockReloadNodes method call, and updates it immediately.
UnselectCell(TreeListNode, TreeListColumn) Discards selection of the cell in the specified intersection.
UnselectCells(TreeListNode, TreeListColumn, TreeListNode, TreeListColumn) Discards selection of the specified range of cells.
UnselectCells(Int32, String, Int32, String) Discards selection of the specified range of cells by data source IDs.
UnselectNode(TreeListNode) Discards selection of the specified node.
UnselectNodes(TreeListNode, TreeListNode) Discards selection of nodes in the specified range.
UnselectNodes(Int32, Int32) Discards selection of nodes in the specified range by data source IDs.
Update() Causes the control to redraw the invalidated regions within its client area. Inherited from Control.
UpdateBounds() protected Updates the bounds of the control with the current size and location. Inherited from Control.
UpdateBounds(Int32, Int32, Int32, Int32, Int32, Int32) protected Updates the bounds of the control with the specified size, location, and client size. Inherited from Control.
UpdateBounds(Int32, Int32, Int32, Int32) protected Updates the bounds of the control with the specified size and location. Inherited from Control.
UpdateStyles() protected Forces the assigned styles to be reapplied to the control. Inherited from Control.
UpdateZOrder() protected Updates the control in its parent’s z-order. Inherited from Control.

Events

Name Description
AfterCheckNode Occurs after a node’s check state has been changed by an end-user.
AfterCollapse Fires immediately after a node has been collapsed.
AfterDragNode Fires immediately after a drag-and-drop operation on a node has been successfully completed.
AfterDropNode Fires after a node is dropped.
AfterExpand Fires immediately after a node has been expanded.
AfterFocusNode Fires in response to focus being moved between nodes.
AutoSizeChanged This event is not relevant for this class. Inherited from Control.
BackColorChanged Occurs when the value of the BackColor property changes. Inherited from Control.
BackgroundImageChanged Occurs when the value of the BackgroundImage property changes. Inherited from Control.
BackgroundImageLayoutChanged Occurs when the BackgroundImageLayout property changes. Inherited from Control.
BandPositionChanged Fires after a band changes its position or visibility.
BandWidthChanged Occurs when the band’s width is changed.
BeforeCheckNode Occurs before a node’s check state is changed.
BeforeCollapse Fires before a node is collapsed.
BeforeDragNode Fires when an attempt to drag a node is performed.
BeforeDropNode Fires when a node is about to be dropped, and allows you to cancel the operation.
BeforeExpand Fires before a node is expanded. Allows you to implement dynamic node loading in unbound mode.
BeforeFocusNode Fires before a node is focused.
BeforeLoadLayout Occurs before a layout is restored from storage (a stream, xml file or the system registry).
BindingContextChanged Occurs when the value of the BindingContext property changes. Inherited from Control.
CalcNodeDragImageIndex Enables you to specify a custom image to be displayed in front of nodes during node drag-and-drop.
CalcNodeHeight Allows you to assign custom node height.
CausesValidationChanged Occurs when the value of the CausesValidation property changes. Inherited from Control.
CellValueChanged Fires immediately after a user closes a cell editor with a modified value.
CellValueChanging Fires when an end-user starts to edit a cell value.
ChangeUICues Occurs when the focus or keyboard user interface (UI) cues change. Inherited from Control.
Click Occurs when the control is clicked. Inherited from Control.
ClientSizeChanged Occurs when the value of the ClientSize property changes. Inherited from Control.
ClipboardNodeCopying Fires before a data row, a group row, column headers, or band headers are copied to the clipboard. Allows you to apply a format, change copied data, or skip a data row or header.
ClipboardNodePasting Fires before a node is pasted to the control. Allows you to apply a format, update the pasted data, or skip a data row.
ColumnButtonClick Fires when the column button is clicked.
ColumnChanged Fires immediately after the column collection or an individual column has been modified.
ColumnFilterChanged Occurs when a column’s filter condition is changed.
ColumnPositionChanged Fires when a column is moved, hidden, or shown.
ColumnUnboundExpressionChanged Fires after a column’s TreeListColumn.UnboundExpression property has been changed.
ColumnWidthChanged Fires after a column’s width has been changed.
CompareNodeValues Enables you to implement custom sorting for columns whose TreeListColumn.SortMode property is set to Custom. For versions 17.1 and higher, the CompareNodeValues event is deprecated and replaced with the TreeList.CustomColumnSort event.
ContextMenuChanged Occurs when the value of the ContextMenu property changes. Inherited from Control.
ContextMenuStripChanged Occurs when the value of the ContextMenuStrip property changes. Inherited from Control.
ControlAdded Occurs when a new control is added to the Control.ControlCollection. Inherited from Control.
ControlRemoved Occurs when a control is removed from the Control.ControlCollection. Inherited from Control.
CreateCustomNode Provides the ability to create custom nodes.
CursorChanged Occurs when the value of the Cursor property changes. Inherited from Control.
CustomColumnDisplayText Fires for both bound and unbound Tree List columns and allows you to provide a custom display text for any cell.
CustomColumnSort Allows you to apply custom sorting for those Tree List columns whose TreeListColumn.SortMode is set to Custom.
CustomDrawBandHeader Provides the capability to custom paint band headers.
CustomDrawColumnHeader Provides the ability to custom paint column headers and the column button.
CustomDrawEmptyArea Enables you to custom paint a Tree List’s empty area.
CustomDrawFilterPanel Enables you to custom paint the Filter Panel.
CustomDrawFooter Gives you the ability to perform custom painting of the summary footer.
CustomDrawFooterCell Gives you the ability to perform custom painting of column footer cells.
CustomDrawNodeButton Gives you the ability to perform custom painting of expand buttons.
CustomDrawNodeCell Provides the ability to perform custom painting of node cells.
CustomDrawNodeCheckBox Enables you to manually paint node check boxes.
CustomDrawNodeImages Provides access to a GDI+/DirectX drawing surface and allows you to draw node icons manually.
CustomDrawNodeIndent Enables tree indents to be painted manually.
CustomDrawNodeIndicator Provides the ability to perform custom painting of indicator cells.
CustomDrawNodePreview Allows you to custom paint preview sections.
CustomDrawRow Enables you to paint rows.
CustomDrawRowFooter Provides the ability to perform custom painting of row footers.
CustomDrawRowFooterCell Provides the ability to perform custom painting of row footer cells.
CustomDrawScroll Allows you to draw custom scrollbars, or highlight specific positions on the scrollbars.
CustomFilterDisplayText Allows you to customize the text displayed within the Filter Panel.
CustomizationFormSearch Allows you to filter search results when a user searches in the Advanced Customization Form.
CustomizeNewNodeFromOuterData Allows you to initialize a new node when a user drops the node from another TreeList control onto the current TreeList control.
CustomizeNodeTemplate Allows you to customize templated nodes.
CustomNodeCellEdit Enables editors to be assigned to cells on an individual basis. To avoid performance issues and increased memory consumption, assign repository items that already exist in the TreeList.RepositoryItems collection. Do not create new repository items in this handler.
CustomNodeCellEditForEditing Allows you to assign a custom editor to a column for in-place editing and override the default column editor, which is by default used both in display and edit modes. To avoid performance issues and increased memory consumption, assign repository items that already exist in the TreeList.RepositoryItems collection. Do not create new repository items in this handler.
CustomRowFilter Allows you to specify the node visibility, regardless of the applied filter.
CustomScrollAnnotation Allows you to specify custom annotations.
CustomUnboundColumnData Allows you to provide data to unbound columns, and save their modified records to an external source.
DataSourceChanged Occurs whenever the TreeList changes its data source.
DefaultPaintHelperChanged Fires when a different paint helper is assigned to the TreeList control.
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DockChanged Occurs when the value of the Dock property changes. Inherited from Control.
DoubleClick Occurs when the control is double-clicked. Inherited from Control.
DragCancelNode Fires immediately after a drag-and-drop operation over a node has been canceled.
DragDrop Occurs when a drag-and-drop operation is completed. Inherited from Control.
DragEnter Occurs when an object is dragged into the control’s bounds. Inherited from Control.
DragLeave Occurs when an object is dragged out of the control’s bounds. Inherited from Control.
DragObjectDrop Fires immediately after the drag and drop operation has been completed.
DragObjectOver Enables you to control whether the dragged column header can be dropped at the current position.
DragObjectStart Fires when an end-user attempts to drag a column header.
DragOver Occurs when an object is dragged over the control’s bounds. Inherited from Control.
EditFormHidden Fires after the Edit Form is closed.
EditFormPrepared Fires when the Edit Form is about to be displayed. Allows you to customize the Edit Form.
EditFormShowing Fires when the Edit Form is about to be displayed. Allows you to cancel the action.
EditorKeyDown Occurs when a key is pressed within an in-place editor that belongs to the container control. Inherited from EditorContainer.
EditorKeyPress Occurs when a character key is pressed within an in-place editor that belongs to the container control. Inherited from EditorContainer.
EditorKeyUp Occurs when a pressed key is released within an in-place editor that belongs to the container control. Inherited from EditorContainer.
EnabledChanged Occurs when the Enabled property value has changed. Inherited from Control.
EndSorting Fires after a sorting operation has finished.
Enter Occurs when the control is entered. Inherited from Control.
FilterEditorCreated Allows you to customize the Filter Editor before it is displayed on screen.
FilterExpressionEditorCreated Allows you to customize the Expression Editor used to edit custom expressions that are displayed in the control’s Filter Editor.
FilterNode This event is obsolete. Use the TreeList.CustomRowFilter event instead.
FilterPopupExcelCustomizeTemplate Allows you to customize templates used by Excel-style Filter Dropdowns and external editors generated using Filtering UI Context.
FilterPopupExcelData Allows you to add, remove, and modify data values and customize predefined filters in the Excel style pop-up filter menus. Filter items added manually on this event must be unique and sorted.
FilterPopupExcelParseFilterCriteria Allows you to parse the filter criteria applied to data and select the corresponding values in the filter menu.
FilterPopupExcelPrepareTemplate Allows you to replace templates used by Excel-style Filter Dropdowns and external editors generated using Filtering UI Context.
FilterPopupExcelQueryFilterCriteria Fires when a filter criteria is about to be applied to data and allows you to customize the filter criteria.
FocusedColumnChanged Fires immediately after focus has been moved from a column.
FocusedNodeChanged Fires when focus moves from one node to another.
FontChanged Occurs when the Font property value changes. Inherited from Control.
ForeColorChanged Occurs when the ForeColor property value changes. Inherited from Control.
FormatRuleExpressionEditorCreated Allows you to customize the Expression Editor embedded in the Edit Formatting Rule dialog.
GetCustomNodeCellEdit Obsolete. Provides the ability to assign editors to individual cells.
GetCustomNodeCellStyle Obsolete. Provides the ability to assign custom style to individual cells.
GetCustomSummaryValue Allows you to specify custom summary values when the control is displayed on-screen.
GetNodeDisplayValue Allows you to display custom values within cells. This event is obsolete. Use the TreeList.CustomColumnDisplayText event instead.
GetPreviewText Enables you to supply custom text for nodes’ preview sections.
GetPrintCustomSummaryValue Allows you to specify custom summary values when the control is printed.
GetPrintPreviewText Enables you to display custom text in preview sections when the control is printed.
GetSelectImage Allows you to assign select images to nodes.
GetStateImage Allows you to assign state images to nodes.
GiveFeedback Occurs during a drag operation. Inherited from Control.
GotFocus Occurs when the control receives focus. Inherited from Control.
HandleCreated Occurs when a handle is created for the control. Inherited from Control.
HandleDestroyed Occurs when the control’s handle is in the process of being destroyed. Inherited from Control.
HelpRequested Occurs when the user requests help for a control. Inherited from Control.
HiddenEditor Fires immediately after a cell editor has been closed.
HideCustomizationForm Fires immediately after the Customization Form has been closed.
HtmlElementMouseClick Occurs when a user clicks an element inside an HTML-CSS template.
HtmlElementMouseDoubleClick Occurs when a user double-clicks any element of an HTML-CSS template.
HtmlElementMouseDown Occurs when a mouse pointer is over an element of an HTML-CSS template, and a mouse button is pressed.
HtmlElementMouseMove Occurs when a mouse pointer moves while over an element of an HTML-CSS template.
HtmlElementMouseOut Occurs when a mouse pointer leaves the bounds of an element within an HTML-CSS template.
HtmlElementMouseOver Occurs when a mouse pointer enters the bounds of an element within an HTML-CSS template.
HtmlElementMouseUp Occurs when a mouse button pressed over an element of an HTML-CSS template is released.
HtmlSelectedTextChanged
HyperlinkClick Fires when a hyperlink in a column or band header is activated.
ImeModeChanged Occurs when the ImeMode property has changed. Inherited from Control.
InitNewRow Fires when a new node is about to be created in the New Item Row and allows you to initialize column values.
Invalidated Occurs when a control’s display requires redrawing. Inherited from Control.
InvalidNodeException Fires when a node fails validation or when its data cannot be saved to the data source.
InvalidValueException Enables you to handle exceptions raised as a result of assigning invalid values to cells.
KeyDown Occurs when a key is pressed while the control has focus. Inherited from Control.
KeyPress Occurs when a character. space or backspace key is pressed while the control has focus. Inherited from Control.
KeyUp Occurs when a key is released while the control has focus. Inherited from Control.
Layout Occurs when a control should reposition its child controls. Inherited from Control.
LayoutUpdated Fires after a Tree List’s layout has been changed.
LayoutUpgrade Occurs after a layout the version of which doesn’t match the current layout version used has been loaded from storage (a stream, xml file or system registry).
Leave Occurs when the input focus leaves the control. Inherited from Control.
LeftCoordChanged Fires when the control’s content is scrolled horizontally.
Load Occurs when a TreeList control is displayed for the first time.
LocationChanged Occurs when the Location property value has changed. Inherited from Control.
LostFocus Occurs when the control loses focus. Inherited from Control.
MarginChanged Occurs when the control’s margin changes. Inherited from Control.
MeasurePreviewHeight Allows you to specify the height of individual preview sections in pixels.
MouseCaptureChanged Occurs when the control loses mouse capture. Inherited from Control.
MouseClick Occurs when the control is clicked by the mouse. Inherited from Control.
MouseDoubleClick Occurs when the control is double clicked by the mouse. Inherited from Control.
MouseDown Occurs when the mouse pointer is over the control and a mouse button is pressed. Inherited from Control.
MouseEnter Occurs when the mouse pointer enters the control. Inherited from Control.
MouseHover Occurs when the mouse pointer rests on the control. Inherited from Control.
MouseLeave Occurs when the mouse pointer leaves the control. Inherited from Control.
MouseMove Occurs when the mouse pointer is moved over the control. Inherited from Control.
MouseUp Occurs when the mouse pointer is over the control and a mouse button is released. Inherited from Control.
MouseWheel Occurs when the mouse wheel moves while the control has focus. Inherited from Control.
Move Occurs when the control is moved. Inherited from Control.
NodeCellStyle Allows you to customize the appearance of individual cells.
NodeChanged Fires after the node’s property has changed.
NodesReloaded Fires when the Tree List control reloads all nodes.
PaddingChanged Occurs when the control’s padding changes. Inherited from Control.
Paint Occurs when the control is redrawn. Inherited from Control.
PaintEx A DirectX-compatible event that replaces the standard Control.Paint event.
ParentChanged Occurs when the Parent property value changes. Inherited from Control.
ParseFindPanelText Fires after the query in the find panel changes. Allows you to create a filter condition based on the query and specify how to highlight results in the control.
PopupMenuShowing Allows you to customize default context menus or invoke custom menus.
PreviewKeyDown Occurs before the KeyDown event when a key is pressed while focus is on this control. Inherited from Control.
PrintExportProgress Fires repeatedly while the TreeList’s data is being printed/exported.
PropertyDeserializing Allows you to restore certain settings previously saved in the layout.
PropertySerializing Allows you to include certain settings in the layout when you save it.
QueryAccessibilityHelp Occurs when AccessibleObject is providing help to accessibility applications. Inherited from Control.
QueryContinueDrag Occurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled. Inherited from Control.
QueryCustomFunctions Allows you to add custom-function-based filters (for example, ‘discount is more than 15%’) to Excel-style pop-up filter menus and/or the filter editor.
QueryEmptyTreeTemplate Allows you to assign HTML-CSS templates from the HtmlTemplates collection to an empty TreeList.
QueryNodeTemplate Allows you to assign HTML-CSS templates from the HtmlTemplates collection to nodes.
RegionChanged Occurs when the value of the Region property changes. Inherited from Control.
Resize Occurs when the control is resized. Inherited from Control.
RightToLeftChanged Occurs when the RightToLeft property value changes. Inherited from Control.
RowCellClick Fires when a cell is clicked.
RowClick Fires when a row (node) is clicked.
RowSelectImageClick Fires when a row’s select image is clicked.
RowStateImageClick Fires when a row’s state image is clicked.
ScrollAnnotationsStyle Allows you to customize the scrollbar annotation color and alignment.
SelectImageClick Fires when the user clicks a node’s select image. This event is obsolete. Use RowSelectImageClick instead.
SelectionChanged Fires when node selection is changed. In v21.1 and higher, the event fires both in single and multiple node selection modes.
SelectionChanging Allows you to specify whether users can select and unselect nodes.
ShowCustomizationForm Fires immediately after the Customization Form has been displayed.
ShowFilterPopupCheckedListBox Fires before a pop-up filter menu is displayed. Allows you to customize the value checklist.
ShowFilterPopupDate Allows you to customize a column’s dropdown calendar before it is displayed.
ShowFilterPopupExcel Allows you to hide specific filter conditions from the Filters tab of the Excel-style Drop-down Filter.
ShowFilterPopupListBox Fires before a pop-up filter menu is displayed. Allows you to customize the value list.
ShowingEditor Fires before the TreeList is switched to edit mode.
ShownEditor Fires immediately after a cell editor has been invoked.
ShowTreeListMenu Obsolete. Allows you to customize the default menus for column headers, row and footer summaries, nodes, and the empty area.
SizeChanged Occurs when the Size property value changes. Inherited from Control.
StartSorting Fires before a sorting operation is started.
StateChanged Fires after the Tree List’s state has changed.
StateImageClick Fires when the user clicks a node’s state image. This event is obsolete. Use RowStateImageClick instead.
StyleChanged Occurs when the control style changes. Inherited from Control.
SubstituteFilter Allows you to replace the applied filter with another filter.
SystemColorsChanged Occurs when the system colors change. Inherited from Control.
TabIndexChanged Occurs when the TabIndex property value changes. Inherited from Control.
TabStopChanged Occurs when the TabStop property value changes. Inherited from Control.
TextChanged Occurs when the Text property value changes. Inherited from Control.
TopVisibleNodeIndexChanged Fires when the control’s content is scrolled vertically.
TreeListMenuItemClick Provides the ability to perform custom handling of a context menu item click.
UnboundExpressionEditorCreated Fires after an Expression Editor has been created for an unbound column.
Validated Occurs when the control is finished validating. Inherited from Control.
ValidateNode Gives you the ability to specify whether a modified node’s data is valid, and if this node can lose focus.
Validating Occurs when the control is validating. Inherited from Control.
ValidatingEditor Fires when an editor is validated.
VirtualTreeGetCellValue This event allows you to initialize cells (and optionally the check state) of the processed node, when populating the Tree List control with data dynamically.
VirtualTreeGetChildNodes Allows you to supply root and child nodes, when populating the Tree List control with data dynamically.
VirtualTreeSetCellValue Allows changes that are made to node cells and check state to be stored.
VisibleChanged Occurs when the Visible property value changes. Inherited from Control.
See Also