TcxDBTreeList Members
A data-aware Tree List control.Constructors
| Name | Description |
|---|---|
| Create(TComponent) | Inherited from TComponent. |
| CreateParented(HWND) | Inherited from TWinControl. |
Properties
| Name | Description |
|---|---|
| AbsoluteCount | Returns the total number of nodes in the Tree List control. Inherited from TcxCustomTreeList. |
| AbsoluteItems | Provides indexed access to all nodes in the Tree List control (regardless of hierarchy levels and visibility). Inherited from TcxCustomTreeList. |
| AbsoluteVisibleCount | Returns the number of visible nodes in the Tree List control (regardless of hierarchy levels). Inherited from TcxCustomTreeList. |
| AbsoluteVisibleItems | Provides indexed access to all visible nodes in the Tree List control (regardless of hierarchy levels). Inherited from TcxCustomTreeList. |
| 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. |
| Automation | Inherited from TcxCustomTreeList. |
| AutoSize | Inherited from TControl. |
| Bands | Provides access to all bands in the Tree List control. Inherited from TcxCustomTreeList. |
| 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 total number of columns in the Tree List control. Inherited from TcxCustomTreeList. |
| Columns | Provides indexed access to all columns. Inherited from TcxCustomTreeList. |
| 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. Inherited from TcxCustomTreeList. |
| 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 nodes at the root level. Inherited from TcxCustomTreeList. |
| Ctl3D | Inherited from TWinControl. |
| CurrentPPI | Inherited from TControl. |
| Cursor | Inherited from TControl. |
| CustomHint | Inherited from TControl. |
| Customizing | References a Customize window instance. Inherited from TcxCustomTreeList. |
| DataController | Provides access to an object that manages the connection to a data source. Inherited from TcxCustomDBTreeList. |
| DateTimeHandling | Provides access to the settings that define how the control shows and filters out date/time values. Inherited from TcxCustomTreeList. |
| DefaultIndentSize | Inherited from TcxCustomTreeList. |
| DefaultLayout | Specifies whether the default layout is applied to the tree list. Inherited from TcxCustomTreeList. |
| DefaultRowHeight | Specifies the default height for all nodes, in pixels. Inherited from TcxCustomTreeList. |
| 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 | Inherited from TcxCustomTreeList. |
| Enabled | Inherited from TControl. |
| ExpansionLevel | Inherited from TcxCustomTreeList. |
| 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. Inherited from TcxCustomTreeList. |
| FilterBox | Provides access to the filter panel settings. Inherited from TcxCustomTreeList. |
| Filtering | Provides access to all filter settings. Inherited from TcxCustomTreeList. |
| FindCriteria | Provides access to the data search criteria and concomitant settings related to the Find Panel functionality. Inherited from TcxCustomTreeList. |
| 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. Inherited from TcxCustomTreeList. |
| FocusedNode | Specifies the focused node. Inherited from TcxCustomTreeList. |
| 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. Inherited from TcxCustomTreeList. |
| 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. Inherited from TcxCustomTreeList. |
| ImeMode | Inherited from TWinControl. |
| ImeName | Inherited from TWinControl. |
| InplaceEditor | Returns the active in-place editor. Inherited from TcxCustomTreeList. |
| IsActive | Indicates whether the control has focus, or if an in-place editor is opened and focused. Inherited from TcxCustomTreeList. |
| IsDesigning | Identifies if the control is being modified by the form designer. Inherited from TcxControl. |
| IsDestroying | Identifies if the control is about to be destroyed. Inherited from TcxCustomControl. |
| IsDrawingLocked | Inherited from TWinControl. |
| IsEditing | Checks whether the tree list is in edit mode. Inherited from TcxCustomTreeList. |
| IsFocused | Identifies if the control has focus. Inherited from TcxControl. |
| IsInserting | Inherited from TcxCustomTreeList. |
| IsLoading | Identifies if the control is being loaded. Inherited from TcxControl. |
| Items | Provides indexed access to all nodes at the root level. Inherited from TcxCustomTreeList. |
| Keys protected | Inherited from TcxControl. |
| LastNode | Returns the last node. Inherited from TcxCustomTreeList. |
| LastPartVisibleNode | Inherited from TcxCustomTreeList. |
| LastVisibleNode | Specifies the lower node visible in the tree list’s View. Inherited from TcxCustomTreeList. |
| 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. Inherited from TcxCustomTreeList. |
| OptionsCustomizing | Specifies the tree list’s options controlling end-user actions. Inherited from TcxCustomTreeList. |
| OptionsData | Provides access to data management settings. Inherited from TcxCustomDBTreeList. |
| OptionsSelection | Specifies the tree list’s node and cell selection options. Inherited from TcxCustomTreeList. |
| OptionsView | Specifies the tree list’s display options. Inherited from TcxCustomTreeList. |
| 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 | Specifies the popup menu associated with the control. Inherited from TcxControl. |
| PopupMenus | Provides access to the TreeList control’s context menus. Inherited from TcxCustomTreeList. |
| Preview | Specifies options for Outlook-style node preview sections. Inherited from TcxCustomTreeList. |
| RaiseOnNonMainThreadUsage | Inherited from TControl. |
| RedrawDisabled | Inherited from TWinControl. |
| Root | Provides access to the virtual node that considered to be the parent of root nodes. Inherited from TcxCustomTreeList. |
| RootValue | Specifies the ParentField property value for root level nodes. Inherited from TcxCustomDBTreeList. |
| ScaleFactor | Inherited from TControl. |
| ScrollbarAnnotations | Provides access to scrollbar annotation settings. Inherited from TcxCustomTreeList. |
| ScrollBars protected | Inherited from TcxControl. |
| Searching | Checks whether an incremental search is currently performed in the tree list. Inherited from TcxCustomTreeList. |
| SearchingText | Specifies the string used by the FindNext method. Inherited from TcxCustomTreeList. |
| SelectionCount | Returns the number of selected nodes. Inherited from TcxCustomTreeList. |
| SelectionList | Provides access to the collection of selected nodes. Inherited from TcxCustomTreeList. |
| Selections | Provides indexed access to the selected nodes. Inherited from TcxCustomTreeList. |
| ShowHint | Inherited from TControl. |
| Showing | Inherited from TWinControl. |
| Sorted | Identifies if columns are sorted. Inherited from TcxCustomTreeList. |
| SortedColumnCount | Returns the number of sorted columns. Inherited from TcxCustomTreeList. |
| SortedColumns | Provides indexed access to sorted columns. Inherited from TcxCustomTreeList. |
| StateImages | Represents a collection of images used for indicating specific states of a node. Inherited from TcxCustomTreeList. |
| StyleElements | Inherited from TControl. |
| StyleName | Inherited from TControl. |
| Styles | Specifies style settings for the tree list’s elements. Inherited from TcxCustomTreeList. |
| Summary | Provides access to the collection of summaries specified in the tree list. Inherited from TcxCustomTreeList. |
| 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. Inherited from TcxCustomTreeList. |
| TopVisibleNode | Specifies the top node visible in the tree list’s View. Inherited from TcxCustomTreeList. |
| 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 | Inherited from TcxCustomTreeList. |
| VCLComObject | Inherited from TComponent. |
| Visible | Inherited from TControl. |
| VisibleColumnCount | Returns the number of visible columns. Inherited from TcxCustomTreeList. |
| VisibleColumns | Provides indexed access to visible columns. Inherited from TcxCustomTreeList. |
| VisibleCount | Returns the number of visible nodes. Inherited from TcxCustomTreeList. |
| 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 | Inherited from TcxExtEditingControl. |
| OnAfterSummary | Occurs after all summaries have been calculated. Inherited from TcxCustomTreeList. |
| OnAlignInsertBefore | Inherited from TWinControl. |
| OnAlignPosition | Inherited from TWinControl. |
| OnBandHeaderClick | Enables you to respond to band header clicks. Inherited from TcxCustomTreeList. |
| OnBandPosChanged | Enables you to respond to end-user changes made to a band‘s visibility or position within the tree list. Inherited from TcxCustomTreeList. |
| OnBandSizeChanged | Enables you to respond to band sizing. Inherited from TcxCustomTreeList. |
| OnBeginDragNode | Enables you to control node dragging. Inherited from TcxCustomTreeList. |
| OnCanFocusNode | Enables you to control which nodes can be focused by end-users. Inherited from TcxCustomTreeList. |
| OnCanResize | Inherited from TControl. |
| OnCanSelectNode | Enables you to control which nodes can be selected by end-users. Inherited from TcxCustomTreeList. |
| OnChange | Enables you to respond to changes made in a tree list. Inherited from TcxCustomTreeList. |
| OnClick | Inherited from TControl. |
| OnCollapsed | Enables you to perform specific actions after a node has been collapsed. Inherited from TcxCustomTreeList. |
| OnCollapsing | Enables you to specify whether a particular node can be collapsed. Inherited from TcxCustomTreeList. |
| OnColumnHeaderClick | Enables you to respond to column header clicks. Inherited from TcxCustomTreeList. |
| OnColumnPosChanged | Enables you to respond to end-user changes made to a column’s visibility or position within the tree list. Inherited from TcxCustomTreeList. |
| OnColumnSizeChanged | Enables you to respond to column resize operations. Inherited from TcxCustomTreeList. |
| OnCompare | Allows you to implement a custom node sorting algorithm. Inherited from TcxCustomTreeList. |
| OnConstrainedResize | Inherited from TControl. |
| OnContextPopup | Inherited from TControl. |
| OnCustomDrawBackgroundCell | Enables you to custom paint the tree list background. Inherited from TcxCustomTreeList. |
| OnCustomDrawBandCell | Enables you to custom draw band backgrounds. Inherited from TcxCustomTreeList. |
| OnCustomDrawBandHeaderCell | Enables you to custom draw band headers. Inherited from TcxCustomTreeList. |
| OnCustomDrawCell protected | Occurs when a cell within a control needs to be painted. Inherited from TcxEditingControl. |
| OnCustomDrawDataCell | Enables you to custom draw data cells. Inherited from TcxCustomTreeList. |
| OnCustomDrawFooterCell | Enables you to custom draw footer cells. Inherited from TcxCustomTreeList. |
| OnCustomDrawHeaderCell | Enables you to custom paint column headers. Inherited from TcxCustomTreeList. |
| OnCustomDrawIndentCell | Enables you to custom draw indent cells. Inherited from TcxCustomTreeList. |
| OnCustomDrawIndicatorCell | Enables you to custom draw node indicators. Inherited from TcxCustomTreeList. |
| OnCustomDrawPreviewCell | Enables you to custom draw preview sections. Inherited from TcxCustomTreeList. |
| OnCustomizationFormVisibleChanged | Inherited from TcxCustomTreeList. |
| OnDataChanged | Enables you to perform specific actions after the data has been posted to a data store. Inherited from TcxCustomTreeList. |
| OnDblClick | Inherited from TControl. |
| OnDeletion | Enables you to perform specific actions when a node is being deleted. Inherited from TcxCustomTreeList. |
| 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 | Enables you to perform specific actions after the data cell‘s in-place editor has been deactivated. Inherited from TcxCustomTreeList. |
| OnEditing | Enables you to specify whether editing is allowed in a particular data cell. Inherited from TcxCustomTreeList. |
| OnEditValueChanged | Enables you to perform specific actions after editing a data cell‘s value is complete. Inherited from TcxCustomTreeList. |
| OnEndDock | Inherited from TControl. |
| OnEndDrag | Inherited from TControl. |
| OnEnter | Inherited from TWinControl. |
| OnExit | Inherited from TWinControl. |
| OnExpanded | Enables you to perform specific actions after a node has been expanded. Inherited from TcxCustomTreeList. |
| OnExpanding | Allows implementing dynamic node loading or prohibiting expansion for individual nodes. Inherited from TcxCustomTreeList. |
| OnFilterControlDialogShow | Enables you to customize the Filter Builder dialog before showing it. Inherited from TcxEditingControl. |
| OnFilterCustomization | Inherited from TcxEditingControl. |
| OnFilterDialogShow | Inherited from TcxEditingControl. |
| OnFilterNode | Enables you to filter out specific nodes. Inherited from TcxCustomTreeList. |
| OnFindCriteriaBeforeChange | Enables you to identify and track any changes made to data search criteria before they take effect on the tree list control. Inherited from TcxCustomTreeList. |
| OnFindCriteriaChanged | Enables you to identify and track all data search criteria changes applied to the tree list control. Inherited from TcxCustomTreeList. |
| OnFindPanelVisibilityChanged | Enables you to track Find Panel visibility changes. Inherited from TcxEditingControl. |
| OnFocusChanged protected | Inherited from TcxControl. |
| OnFocusedColumnChanged | Enables you to perform specific actions after an active column has been changed. Inherited from TcxCustomTreeList. |
| OnFocusedNodeChanged | Enables you to respond to node focusing. Inherited from TcxCustomTreeList. |
| OnGesture | Inherited from TControl. |
| OnGetCellHint | Enables you to customize a View element’s hint. Inherited from TcxCustomTreeList. |
| OnGetDragDropText | Enables you to customize the drag and drop hint’s text. Inherited from TcxCustomTreeList. |
| OnGetLevelImages | Enables you to associate certain node image collections with the corresponding node levels. Inherited from TcxCustomTreeList. |
| OnGetNodeHeight | Enables you to specify the custom height for individual nodes. Inherited from TcxCustomTreeList. |
| OnGetNodeImageIndex | Enables you to specify custom images for nodes. Inherited from TcxCustomTreeList. |
| OnGetNodePreviewHeight | Enables you to specify the custom height for individual preview sections. Inherited from TcxCustomTreeList. |
| OnGetScrollbarAnnotationHint | Enables you to display hints for scrollbar annotations. Inherited from TcxEditingControl. |
| OnGetSiteInfo | Inherited from TWinControl. |
| OnGetStoredProperties | Allows you to customize a list of tree list properties saved to external storages. Inherited from TcxCustomTreeList. |
| OnGetStoredPropertyValue | Enables you to provide values for tree list properties to be saved to external data stores. Inherited from TcxCustomTreeList. |
| OnGetUniqueKeyValue | Enables you to specify the key field value (also called the unique identifier) for a new node. Inherited from TcxCustomDBTreeList. |
| OnHotTrackNode | Enables you to respond to node hot-tracking. Inherited from TcxCustomTreeList. |
| OnInitEdit | Enables you to customize an in-place cell editor when it is invoked. Inherited from TcxEditingControl. |
| OnInitEditValue | Enables you to change the edit value for an invoked in-place cell editor. Inherited from TcxEditingControl. |
| OnInitFilteringDateRanges | Inherited from TcxEditingControl. |
| OnInitInsertingRecord | Occurs before a node is inserted into the TreeList control. Inherited from TcxCustomDBTreeList. |
| OnInitStoredObject | Allows you to initialize columns created when restoring the tree list layout from external sources. Inherited from TcxCustomTreeList. |
| OnIsGroupNode | Allows you to specify group nodes. Inherited from TcxCustomTreeList. |
| OnKeyDown | Inherited from TWinControl. |
| OnKeyPress | Inherited from TWinControl. |
| OnKeyUp | Inherited from TWinControl. |
| OnLayoutChanged | Enables you to respond to tree list updates. Inherited from TcxCustomTreeList. |
| OnLeftPosChanged | Enables you to respond when the current tree list is horizontally scrolled, either by keyboard navigation or by moving the horizontal scrollbar. Inherited from TcxCustomTreeList. |
| OnMouseActivate | Inherited from TControl. |
| OnMouseDown | Inherited from TControl. |
| OnMouseEnter | Occurs when the mouse pointer enters into the control. Inherited from TcxControl. |
| OnMouseLeave | 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 | Enables you to respond to node dragging within the tree list. Inherited from TcxCustomTreeList. |
| OnNodeChanged | Enables you to respond to changes made to a node. Inherited from TcxCustomTreeList. |
| OnNodeCheckChanged | Enables you to respond to a change made to a node’s checked state. Inherited from TcxCustomTreeList. |
| OnNodeCheckChanging protected | Enables you to prohibit a node from changing its checked state. Inherited from TcxCustomTreeList. |
| OnPopulateCustomScrollbarAnnotationRowIndexList | Enables you to display custom scrollbar annotations. Inherited from TcxEditingControl. |
| OnResize | Inherited from TControl. |
| OnSelectionChanged | Enables you to respond to node selections. Inherited from TcxCustomTreeList. |
| OnSetStoredPropertyValue | Enables you to restore tree list property values from external data stores. Inherited from TcxCustomTreeList. |
| OnSorted | Enables you to perform specific actions after node sorting is complete. Inherited from TcxCustomTreeList. |
| OnSorting | Enables you to perform specific actions when sorting nodes. Inherited from TcxCustomTreeList. |
| OnStartDock | Inherited from TControl. |
| OnStartDrag | Inherited from TControl. |
| OnSummary | Enables you to perform custom summary calculations. Inherited from TcxCustomTreeList. |
| OnTopRecordIndexChanged | Occurs when scrolling the TreeList conrol’s contents. Inherited from TcxCustomTreeList. |
| OnUnDock | Inherited from TWinControl. |
| PopupMenusEvents | Inherited from TcxCustomTreeList. |
| StylesEvents | Inherited from TcxCustomTreeList. |
See Also