TcxCustomTreeList Members
The base class all Tree List controls.Constructors
Name | Description |
---|---|
Create(TComponent) | Inherited from TComponent. |
CreateParented(HWND) | Inherited from TWinControl. |
Properties
Name | Description |
---|---|
AbsoluteCount | Returns the number of nodes created in the tree list. |
AbsoluteItems | Provides zero-based indexed access to nodes created in the tree list. |
AbsoluteVisibleCount | Returns the number of nodes that are visible in the tree list. |
AbsoluteVisibleItems | Provides zero-based indexed access to nodes that are visible in the tree list. |
Action | Inherited from TControl. |
ActiveCanvas | Provides access to the control’s GDI-based canvas. Inherited from TcxControl. |
Align | Inherited from TControl. |
AlignDisabled | Inherited from TWinControl. |
AlignWithMargins | Inherited from TControl. |
Anchors | Inherited from TControl. |
AutoSize | Inherited from TControl. |
Bands | Provides access to the tree list bands. |
BevelEdges | Inherited from TWinControl. |
BevelInner | Inherited from TWinControl. |
BevelKind | Inherited from TWinControl. |
BevelOuter | Inherited from TWinControl. |
BevelWidth | Inherited from TWinControl. |
BiDiMode | Inherited from TControl. |
BorderSize | Inherited from TcxControl. |
BorderStyle | Inherited from TcxEditingControl. |
BorderWidth | Inherited from TWinControl. |
Bounds | Returns the control’s boundaries. Inherited from TcxControl. |
BoundsRect | Inherited from TControl. |
Brush | Inherited from TWinControl. |
BufferedPaint | Determines whether the control’s image is rendered directly in the window or is first painted to an in-memory bitmap. Inherited from TcxEditingControl. |
Canvas | Provides access to the control’s GDI-based canvas. Inherited from TcxControl. |
Caption | Inherited from TControl. |
ClientBounds | Returns the control’s client area. Inherited from TcxControl. |
ClientHeight | Inherited from TControl. |
ClientOrigin | Inherited from TControl. |
ClientRect | Inherited from TControl. |
ClientWidth | Inherited from TControl. |
Color | Inherited from TControl. |
ColumnCount | Returns the number of columns. |
Columns | Provides indexed access to columns. |
ComObject | Inherited from TComponent. |
ComponentCount | Inherited from TComponent. |
ComponentIndex | Inherited from TComponent. |
Components | Inherited from TComponent. |
ComponentState | Inherited from TComponent. |
ComponentStyle | Inherited from TComponent. |
ConditionalFormatting | Provides access to the conditional formatting controller. |
Constraints | Inherited from TControl. |
ControlCount | Inherited from TWinControl. |
Controls | Inherited from TWinControl. |
ControlState | Inherited from TControl. |
ControlStyle | Inherited from TControl. |
Count | Returns the number of root level nodes. |
Ctl3D | Inherited from TWinControl. |
CurrentPPI | Inherited from TControl. |
Cursor | Inherited from TControl. |
CustomHint | Inherited from TControl. |
Customizing | References a Customize window instance. |
DataController protected | Inherited from TcxEditingControl. |
DateTimeHandling protected | Provides access to the settings that define how the control shows and filters out date/time values. |
DefaultIndentSize | |
DefaultLayout | Specifies whether the default layout is applied to the tree list. |
DefaultRowHeight | Specifies the default height for all nodes, in pixels. |
DesignInfo | Inherited from TComponent. |
DockClientCount | Inherited from TWinControl. |
DockClients | Inherited from TWinControl. |
DockManager | Inherited from TWinControl. |
DockOrientation | Inherited from TControl. |
DockSite | Inherited from TWinControl. |
DoubleBuffered | Inherited from TWinControl. |
DragAndDropObject | Inherited from TcxControl. |
DragAndDropObjectClass | Inherited from TcxControl. |
DragAndDropState | Inherited from TcxControl. |
DragCursor | Inherited from TcxEditingControl. |
DragKind | Inherited from TControl. |
DragMode | Inherited from TControl. |
DragNode | |
Enabled | Inherited from TControl. |
ExpansionLevel | |
ExplicitHeight | Inherited from TControl. |
ExplicitLeft | Inherited from TControl. |
ExplicitTop | Inherited from TControl. |
ExplicitWidth | Inherited from TControl. |
Filter | Provides access to the filter applied to the tree list. |
FilterBox protected | Provides access to the filter panel settings. |
Filtering protected | Provides access to all filter settings. |
FindCriteria | Provides access to the data search criteria and concomitant settings related to the Find Panel functionality. |
FindPanel | Provides access to the settings that define the appearance and behavior of the control’s Find Panel and its elements. Inherited from TcxExtEditingControl. |
Floating | Inherited from TControl. |
FloatingDockSiteClass | Inherited from TControl. |
FocusedColumn | Specifies the focused column. |
FocusedNode | Specifies the focused node. |
FocusOnClick protected | Specifies if clicking the control focuses it. Inherited from TcxControl. |
Font | Inherited from TControl. |
Handle | Inherited from TWinControl. |
Height | Inherited from TControl. |
HelpContext | Inherited from TControl. |
HelpKeyword | Inherited from TControl. |
HelpType | Inherited from TControl. |
Hint | Specifies a hint message for the control. Inherited from TcxControl. |
HitTest | Returns HitTest information about the tree list element located at a specific point. |
HostDockSite | Inherited from TControl. |
HScrollBar protected | Inherited from TcxControl. |
HScrollBarVisible protected | Inherited from TcxControl. |
Images | Represents a collection of images used as an indication of focused nodes. |
ImeMode | Inherited from TWinControl. |
ImeName | Inherited from TWinControl. |
InplaceEditor | Returns the active in-place editor. |
IsActive | Indicates whether the control has focus, or if an in-place editor is opened and focused. |
IsDesigning | Indicates if the control is currently being manipulated by the form designer. Inherited from TcxControl. |
IsDestroying | Indicates if the control is about to be destroyed. Inherited from TcxControl. |
IsDrawingLocked | Inherited from TWinControl. |
IsEditing | Checks whether the tree list is in edit mode. |
IsFocused | Identifies if the control is focused. Inherited from TcxControl. |
IsInserting | |
IsLoading | Indicates if the control is being loaded. Inherited from TcxControl. |
Items | Provides indexed access to the root level nodes. |
Keys protected | Inherited from TcxControl. |
LastNode | Returns the last node. |
LastPartVisibleNode | |
LastVisibleNode | Specifies the lower node visible in the tree list’s View. |
Left | Inherited from TControl. |
LockUpdate | Indicates the number of BeginUpdate method calls that have not been matched by EndUpdate method calls. Inherited from TcxEditingControl. |
LookAndFeel | Provides access to the control’s look & feel settings. Inherited from TcxControl. |
LookAndFeelPainter protected | Inherited from TcxControl. |
LRDockWidth | Inherited from TControl. |
Margins | Inherited from TControl. |
MouseCapture | Inherited from TControl. |
MouseCaptureObject | Provides access to the dragged object during a drag-and-drop operation. Inherited from TcxControl. |
MouseDownPos | Specifies the mouse pointer position when an OnMouseDown event occurs. Inherited from TcxControl. |
MouseInClient | Inherited from TWinControl. |
Name | Inherited from TComponent. |
Navigator | Provides access to the settings that define the appearance and behavior of the embedded navigator and its elements. Inherited from TcxExtEditingControl. |
Observers | Inherited from TComponent. |
OptionsBehavior | Specifies the tree list’s behavior options. |
OptionsCustomizing | Specifies the tree list’s options controlling end-user actions. |
OptionsData | Specifies the tree list’s data processing options. |
OptionsSelection | Specifies the tree list’s node and cell selection options. |
OptionsView | Specifies the tree list’s display options. |
Owner | Inherited from TComponent. |
Padding | Inherited from TWinControl. |
Parent | Inherited from TControl. |
ParentBackground protected | Inherited from TcxControl. |
ParentBiDiMode | Inherited from TControl. |
ParentColor | Inherited from TControl. |
ParentCtl3D | Inherited from TWinControl. |
ParentCustomHint | Inherited from TControl. |
ParentDoubleBuffered | Inherited from TWinControl. |
ParentFont | Inherited from TControl. |
ParentShowHint | Inherited from TControl. |
ParentWindow | Inherited from TWinControl. |
PixelsPerInch | Inherited from TWinControl. |
PopupMenu protected | Specifies the popup menu associated with the control. Inherited from TcxControl. |
PopupMenus | Provides access to the TreeList control’s context menus. |
Preview | Specifies options for Outlook-style node preview sections. |
RaiseOnNonMainThreadUsage | Inherited from TControl. |
RedrawDisabled | Inherited from TWinControl. |
Root | Provides access to the virtual node that considered to be the parent of root nodes. |
ScaleFactor | Inherited from TControl. |
ScrollbarAnnotations | Provides access to scrollbar annotation settings. |
ScrollBars protected | Inherited from TcxControl. |
Searching | Checks whether an incremental search is currently performed in the tree list. |
SearchingText | Specifies the string used by the FindNext method. |
SelectionCount | Returns the number of selected nodes. |
SelectionList | Provides access to the collection of selected nodes. |
Selections | Provides indexed access to the selected nodes. |
ShowHint | Inherited from TControl. |
Showing | Inherited from TWinControl. |
Sorted | Identifies if columns are sorted. |
SortedColumnCount | Returns the number of sorted columns. |
SortedColumns | Provides indexed access to sorted columns. |
StateImages | Represents a collection of images used for indicating specific states of a node. |
StyleElements | Inherited from TControl. |
StyleName | Inherited from TControl. |
Styles | Specifies style settings for the tree list’s elements. |
Summary | Provides access to the collection of summaries specified in the tree list. |
TabOrder | Inherited from TWinControl. |
TabStop | Inherited from TcxControl. |
Tag | Inherited from TComponent. |
TBDockHeight | Inherited from TControl. |
Text | Inherited from TControl. |
TipMode | Inherited from TWinControl. |
Top | Inherited from TControl. |
TopNode | Returns the first node instance. |
TopVisibleNode | Specifies the top node visible in the tree list’s View. |
Touch | Inherited from TControl. |
Transparent protected | Specifies if the control is transparent in GDI render mode. Inherited from TcxControl. |
UndockHeight | Inherited from TControl. |
UndockWidth | Inherited from TControl. |
UseDockManager | Inherited from TWinControl. |
UseLightBorders | |
VCLComObject | Inherited from TComponent. |
Visible | Inherited from TControl. |
VisibleColumnCount | Returns the number of visible columns. |
VisibleColumns | Provides indexed access to visible columns. |
VisibleCount | Returns the number of visible nodes. |
VisibleDockClientCount | Inherited from TWinControl. |
VScrollBar protected | Inherited from TcxControl. |
VScrollBarVisible protected | Inherited from TcxControl. |
Width | Inherited from TControl. |
WindowProc | Inherited from TControl. |
Methods
Events
Name | Description |
---|---|
NavigatorEvents protected | Inherited from TcxExtEditingControl. |
OnAfterSummary protected | Occurs after all summaries have been calculated. |
OnAlignInsertBefore | Inherited from TWinControl. |
OnAlignPosition | Inherited from TWinControl. |
OnBandHeaderClick protected | Enables you to respond to band header clicks. |
OnBandPosChanged protected | Enables you to respond to end-user changes made to a band‘s visibility or position within the tree list. |
OnBandSizeChanged protected | Enables you to respond to band sizing. |
OnBeginDragNode protected | Enables you to control node dragging. |
OnCanFocusNode protected | Enables you to control which nodes can be focused by end-users. |
OnCanResize | Inherited from TControl. |
OnCanSelectNode protected | Enables you to control which nodes can be selected by end-users. |
OnChange protected | Enables you to respond to changes made in a tree list. |
OnClick | Inherited from TControl. |
OnCollapsed protected | Enables you to perform specific actions after a node has been collapsed. |
OnCollapsing protected | Enables you to specify whether a particular node can be collapsed. |
OnColumnHeaderClick protected | Enables you to respond to column header clicks. |
OnColumnPosChanged protected | Enables you to respond to end-user changes made to a column’s visibility or position within the tree list. |
OnColumnSizeChanged protected | Enables you to respond to column resize operations. |
OnCompare protected | Allows you to implement a custom node sorting algorithm. |
OnConstrainedResize | Inherited from TControl. |
OnContextPopup | Inherited from TControl. |
OnCustomDrawBackgroundCell protected | Enables you to custom paint the tree list background. |
OnCustomDrawBandCell protected | Enables you to custom draw band backgrounds. |
OnCustomDrawBandHeaderCell protected | Enables you to custom draw band headers. |
OnCustomDrawCell protected | Occurs when a cell within a control needs to be painted. Inherited from TcxEditingControl. |
OnCustomDrawDataCell protected | Enables you to custom draw data cells. |
OnCustomDrawFooterCell protected | Enables you to custom draw footer cells. |
OnCustomDrawHeaderCell protected | Enables you to custom paint column headers. |
OnCustomDrawIndentCell protected | Enables you to custom draw indent cells. |
OnCustomDrawIndicatorCell protected | Enables you to custom draw node indicators. |
OnCustomDrawPreviewCell protected | Enables you to custom draw preview sections. |
OnCustomizationFormVisibleChanged protected | |
OnDataChanged protected | Enables you to perform specific actions after the data has been posted to a data store. |
OnDblClick | Inherited from TControl. |
OnDeletion protected | Enables you to perform specific actions when a node is being deleted. |
OnDockDrop | Inherited from TWinControl. |
OnDockOver | Inherited from TWinControl. |
OnDragDrop | Inherited from TControl. |
OnDragOver | Inherited from TControl. |
OnEditChanged protected | Occurs when changing an open editor’s value. Inherited from TcxEditingControl. |
OnEdited protected | Enables you to perform specific actions after the data cell‘s in-place editor has been deactivated. |
OnEditing protected | Enables you to specify whether editing is allowed in a particular data cell. |
OnEditValueChanged protected | Enables you to perform specific actions after editing a data cell‘s value is complete. |
OnEndDock | Inherited from TControl. |
OnEndDrag | Inherited from TControl. |
OnEnter | Inherited from TWinControl. |
OnExit | Inherited from TWinControl. |
OnExpanded protected | Enables you to perform specific actions after a node has been expanded. |
OnExpanding protected | Allows implementing dynamic node loading or prohibiting expansion for individual nodes. |
OnFilterControlDialogShow protected | Enables you to customize the Filter Builder dialog before showing it. Inherited from TcxEditingControl. |
OnFilterCustomization protected | Inherited from TcxEditingControl. |
OnFilterDialogShow protected | Inherited from TcxEditingControl. |
OnFilterNode protected | Enables you to filter out specific nodes. |
OnFindCriteriaBeforeChange protected | Enables you to identify and track any changes made to data search criteria before they take effect on the tree list control. |
OnFindCriteriaChanged protected | Enables you to identify and track all data search criteria changes applied to the tree list control. |
OnFindPanelVisibilityChanged protected | Enables you to track Find Panel visibility changes. Inherited from TcxEditingControl. |
OnFocusChanged protected | Inherited from TcxControl. |
OnFocusedColumnChanged protected | Enables you to perform specific actions after an active column has been changed. |
OnFocusedNodeChanged protected | Enables you to respond to node focusing. |
OnGesture | Inherited from TControl. |
OnGetCellHint protected | Enables you to customize a View element’s hint. |
OnGetDragDropText protected | Enables you to customize the drag and drop hint’s text. |
OnGetLevelImages protected | Enables you to associate certain node image collections with the corresponding node levels. |
OnGetNodeHeight protected | Enables you to specify the custom height for individual nodes. |
OnGetNodeImageIndex protected | Enables you to specify custom images for nodes. |
OnGetNodePreviewHeight protected | Enables you to specify the custom height for individual preview sections. |
OnGetScrollbarAnnotationHint protected | Enables you to display hints for scrollbar annotations. Inherited from TcxEditingControl. |
OnGetSiteInfo | Inherited from TWinControl. |
OnGetStoredProperties protected | Enables you to customize a list of the tree list’s properties to be stored to external data stores. |
OnGetStoredPropertyValue protected | Enables you to provide values for tree list properties to be saved to external data stores. |
OnHotTrackNode protected | Enables you to respond to node hot-tracking. |
OnInitEdit protected | Enables you to customize an in-place cell editor when it is invoked. Inherited from TcxEditingControl. |
OnInitEditValue protected | Enables you to change the edit value for an invoked in-place cell editor. Inherited from TcxEditingControl. |
OnInitFilteringDateRanges protected | Inherited from TcxEditingControl. |
OnInitStoredObject protected | Enables you to initialize columns that are created when restoring the tree list’s layout from external data stores. |
OnIsGroupNode protected | Allows you to specify group nodes. |
OnKeyDown | Inherited from TWinControl. |
OnKeyPress | Inherited from TWinControl. |
OnKeyUp | Inherited from TWinControl. |
OnLayoutChanged protected | Enables you to respond to tree list updates. |
OnLeftPosChanged protected | Enables you to respond when the current tree list is horizontally scrolled, either by keyboard navigation or by moving the horizontal scrollbar. |
OnMouseActivate | Inherited from TControl. |
OnMouseDown | Inherited from TControl. |
OnMouseEnter protected | Occurs when the mouse pointer enters into the control. Inherited from TcxControl. |
OnMouseLeave protected | Occurs when the mouse pointer leaves the control. Inherited from TcxControl. |
OnMouseMove | Inherited from TControl. |
OnMouseUp | Inherited from TControl. |
OnMouseWheel | Inherited from TControl. |
OnMouseWheelDown | Inherited from TControl. |
OnMouseWheelUp | Inherited from TControl. |
OnMoveTo protected | Enables you to respond to node dragging within the tree list. |
OnNodeChanged protected | Enables you to respond to changes made to a node. |
OnNodeCheckChanged protected | Enables you to respond to a change made to a node’s checked state. |
OnNodeCheckChanging protected | Enables you to prohibit a node from changing its checked state. |
OnPopulateCustomScrollbarAnnotationRowIndexList protected | Enables you to display custom scrollbar annotations. Inherited from TcxEditingControl. |
OnResize | Inherited from TControl. |
OnSelectionChanged protected | Enables you to respond to node selections. |
OnSetStoredPropertyValue protected | Enables you to restore tree list property values from external data stores. |
OnSorted protected | Enables you to perform specific actions after node sorting is complete. |
OnSorting protected | Enables you to perform specific actions when sorting nodes. |
OnStartDock | Inherited from TControl. |
OnStartDrag | Inherited from TControl. |
OnSummary protected | Enables you to perform custom summary calculations. |
OnTopRecordIndexChanged protected | Occurs when scrolling the TreeList conrol’s contents. |
OnUnDock | Inherited from TWinControl. |
PopupMenusEvents protected | |
StylesEvents protected |
See Also