TreeList Properties

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

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 | Use TreeList.ShowFindPanel and TreeList.HideFindPanel methods to show or hide the Find Panel. | | 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 | Contains 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. |