TTreeView class
TTreeView is a control that displays a hierarchical list of items.Declaration
TTreeView = class(TCustomTreeView)Inheritance
Description
Use a TTreeView to display a hierarchical list of items. Items are
shown by their caption and an optional bitmap.
See also
Properties
PathDelimiter | public | Delimiter used to separate node identifiers in the path to a given tree node. |
ScrolledLeft | public | Horizontal coordinate for the origin of the visible display area. |
ScrolledTop | public | Vertical coordinate for the origin of the visible display area. |
Align | published | Specifies the placement of the control on its Parent control. |
Anchors | published | The set of anchor definitions for this control. |
AutoExpand | published | Expands a tree node when it is clicked or activated in code. |
BorderSpacing | published | Determines the inner and outer border spacing for this control. |
BackgroundColor | published | Color of the background area on the control. |
BorderStyle | published | Indicates the border style displayed around the control. |
BorderWidth | published | Width of the Border around the control; default is zero. |
Color | published | The background color for the control. |
Constraints | published | Contains the minimum and maximum Width and Height for the control. |
DefaultItemHeight | published | Default height for tree nodes in the control. |
DisabledFontColor | published | Font color used for a tree node when the tree view or the node is not enabled. |
DragKind | published | Indicates the action performed for a drag operation: drag-and-drop or drag-and-dock. |
DragCursor | published | The cursor shape shown during a drag operation. |
DragMode | published | Determines how a drag operation is started for the control. |
Enabled | published | Determines whether the control responds to mouse or keyboard input. |
ExpandSignColor | published | Color used to paint expand / collapse (fold / unfold) indicators for tree nodes. |
ExpandSignSize | published | Size of the expand / collapse (fold / unfold) indicators for tree nodes. |
ExpandSignType | published | Sets the drawing style for the expand / collapse (fold/unfold) indicators for tree nodes. |
Font | published | The font to be used for text display in this control. |
HideSelection | published | Indicates if the highlighting for current selection(s) are hidden when the control loses focus. |
HotTrack | published | Enables or disables highlight / underline drawing styles on a tree item when the mouse is hovered over it. |
HotTrackColor | published | Font color used to draw the text on a hovered tree node when hot tracking is enabled. |
Images | published | Image list which holds icons for the tree nodes in Items. |
ImagesWidth | published | Width for the Images used in the tree view control. |
Indent | published | Number of pixels used to indent branch levels (child nodes) on the tree view control. |
MultiSelect | published | Enables or disables selection of multiple tree nodes at the same time. |
MultiSelectStyle | published | Multi-selection options enabled for the tree view control. |
ParentColor | published | Use the Color from the Parent control, when enabled. |
ParentFont | published | Indicates if the Font from the Parent control is used in the control. |
ParentShowHint | published | If True, the value of ShowHint for the control will be the same as the one from the Parent. Default is True. |
PopupMenu | published | A context-sensitive menu that pops up when the right mouse button is clicked over this control. |
ReadOnly | published | Indicates whether the text (or caption) for tree nodes can be edited in the control. |
RightClickSelect | published | Right-click also selects tree-item. Else it only calls PopupMenu. |
RowSelect | published | Paints the selection background over the full width of the control for a selected tree node. |
ScrollBars | published | Specifies the scroll bars displayed for the tree view control. |
SelectionColor | published | Color used to paint the background for the selected tree node in the control. |
SelectionFontColor | published | Color used to draw the text for a (multi-)selected item when enabled. |
SelectionFontColorUsed | published | Indicates if the selection font color is used for selected items. |
SeparatorColor | published | Color used to paint horizontal lines between tree nodes when enabled. |
ShowButtons | published | Enables an expand/collapse (fold/unfold) icon for nodes with child nodes. |
ShowHint | published | Enables Hint display for the control. |
ShowLines | published | Enables or disables the horizontal and vertical lines which join nodes in the tree hierarchy. |
ShowRoot | published | Enables or disables drawing the root node for the tree view control. |
ShowSeparators | published | Indicates whether horizontal separator lines are drawn between nodes on the tree view control. |
SortType | published | Allows items to be sorted by caption, by the Data property, or both. |
StateImages | published | Image list with the bitmaps used to represent the state for nodes in the tree. |
StateImagesWidth | published | Width for the bitmaps in the StateImages property. |
TabOrder | published | Indicates the navigation order for the control when the user presses the Tab or Shift+Tab key. |
TabStop | published | Enables or disables navigation using the Tab key. |
Tag | published | Tag value of the component. |
ToolTips | published | Indicates whether tool tips (hints) are enabled for nodes on the tree view control. |
Visible | published | Allows the control, and all of its children, to be displayed or hidden. |
Options | published | The set of options enabled in the tree view control. |
Items | published | The container with the TTreeNode instances for the control. |
TreeLineColor | published | Color used to draw the lines which connect the nodes in the tree. |
TreeLinePenStyle | published | Style of the TPen used to draw lines used to connect nodes in the control. |
Events
OnAddition | published | Event handler signalled when a tree node is added to the Items in the tree view control. |
OnAdvancedCustomDraw | published | Event handler signalled to custom draw the grid control using drawing stages. |
OnAdvancedCustomDrawItem | published | OnAdvancedCustomDrawItem - event handler for advanced custom drawing item. |
OnChange | published | Event handler for a change notification in the tree view control. |
OnChanging | published | Event handler signalled before the selected node in the tree view control is changed. |
OnClick | published | Notification handler for mouse clicks. |
OnCollapsed | published | Event handler signalled when a tree node has been collapsed on the control. |
OnCollapsing | published | Event handler signalled prior to collapsing a node on the tree view control. |
OnCompare | published | Event handler signalled to compare and sort tree nodes in their default order. |
OnContextPopup | published | Invoked when a context-sensitive pop-up menu is requested. |
OnCreateNodeClass | published | Event handler signalled to get the class reference used to create new tree nodes. |
OnCustomCreateItem | published | OnCustomCreateItem - event handler for custom item creation. |
OnCustomDraw | published | Event handler signalled to perform custom drawing for the tree view control. |
OnCustomDrawItem | published | Event handler signalled to custom draw an item (tree node) on the control. |
OnCustomDrawArrow | published | Event handler signalled to custom draw expand / collapse (fold) indicators for a tree node. |
OnDblClick | published | Event handler signalled when a mouse double click occurs in the control. |
OnDeletion | published | Event handler signalled when a node is deleted from the node tree. |
OnDragDrop | published | Event handler signalled when an object is dropped onto the control. |
OnDragOver | published | Event handler signalled when a control is dragged over the control instance. |
OnEdited | published | Event handler signalled when the tree view control has been edited. |
OnEditing | published | Event handler signalled to determine whether the editor can be enabled for a tree node. |
OnEditingEnd | published | Event handler signalled when EndEditing is called for the control. |
OnEndDrag | published | Event handler signalled for the end of a drag-drop operation. |
OnEnter | published | Event handler signalled when the control receives focus. |
OnExit | published | Event handler signalled when the control loses focus. |
OnExpanded | published | Event handler signalled when a node on the tree view control has been expanded. |
OnExpanding | published | Event handler signalled prior to expanding a node on the tree view control. |
OnGetImageIndex | published | Event handler signalled to get the ordinal position for the image displayed on a tree node. |
OnGetSelectedIndex | published | Event handler signalled to get the ordinal position for the image displayed for a selected node on the tree view control. |
OnHasChildren | published | Event handler signalled to determine if a given node in the tree view has child nodes. |
OnKeyDown | published | Event handler signalled for key down keyboard events. |
OnKeyPress | published | Event handler signalled for character data entered by the user. |
OnKeyUp | published | Event handler signalled when a key up event has occurred for the control. |
OnMouseDown | published | Event handler signalled when a mouse down event is handled for the control. |
OnMouseEnter | published | Event handler signalled when the mouse pointer has entered the control. |
OnMouseLeave | published | Event handler signalled when the mouse pointer has left the control. |
OnMouseMove | published | Event handler signalled when the mouse pointer is moved in the control. |
OnMouseUp | published | Event handler signalled when a mouse up event is handled for the control. |
OnMouseWheel | published | Event handler for mouse wheel turned. |
OnMouseWheelDown | published | Event handler signalled for a downward movement of the mouse wheel. |
OnMouseWheelUp | published | Event handler signalled for an upward movement of the mouse wheel. |
OnMouseWheelHorz | published | Event handler signalled for a horizontal movement of the mouse wheel. |
OnMouseWheelLeft | published | Event handler signalled for a leftward movement of the mouse wheel. |
OnMouseWheelRight | published | Event handler signalled for a rightward movement of the mouse wheel. |
OnNodeChanged | published | Event handler signalled when the text for a tree node has been changed. |
OnResize | published | Notification handler for a resize of the control. |
OnSelectionChanged | published | Event handler signalled when the selection in the tree view control is changed. |
OnShowHint | published | Event handler signalled when a hint window is displayed for the control. |
OnStartDrag | published | Event handler signalled for the start of a dragging operation. |
OnUTF8KeyPress | published | Handler for a character entered by the user. |
Inherited
From TCustomTreeView (143)
AccessibilityOn Added AlphaSort ApplyStoredSelection BeginAutoDrag BeginEditing BeginUpdate BottomItem CanChange CanCollapse CanEdit CanExpand Change ClearInvisibleSelection ClearSelection Click Collapse ConsistencyCheck Create CreateNode CreateNodes CreateWnd CustomDraw CustomDrawItem CustomSort DblClick DefaultItemHeightIsStored DefaultTreeViewSort Delete Destroy DestroyWnd DoAutoAdjustLayout DoCreateNodeClass DoDragMsg DoEndDrag DoMouseWheel DoMouseWheelHorz DoPaint DoPaintNode DoSelectionChanged DoStartDrag DragOver DrawBuiltinIcon DropTarget EditingItem EditorEditingDone EditorKeyDown EndEditing EndUpdate EnsureNodeIsVisible EraseBackground Expand ExpandSignSizeIsStored ExpandSignWidth FullCollapse FullExpand GetBuiltinIconSize GetChildAccessibleObjectAtPos GetControlClassDefaultSize GetDragImages GetFirstMultiSelected GetHitTestInfoAt GetImageIndex GetImageSize GetInsertMarkAt GetLastMultiSelected GetMaxLvl GetMaxScrollLeft GetMaxScrollTop GetNodeAt GetNodeAtY GetNodeDrawAreaHeight GetNodeDrawAreaWidth GetNodeWithExpandSignAt GetSelectedChildAccessibleObject GetSelectedIndex IndentIsStored InitializeWnd InsertMarkNode InsertMarkType Invalidate IsCustomDrawn IsEditing IsInsertMarkVisible IsNodeHeightFullVisible IsNodeVisible KeepCollapsedNodes KeyDown Loaded LoadFromFile LoadFromStream LockSelectionChangeEvent MakeSelectionVisible MouseDown MouseLeave MouseMove MouseUp MoveCollapse MoveEnd MoveExpand MoveHome MoveLeft MovePageDown MovePageUp MoveRight MoveSelection MoveToNextNode MoveToPrevNode NodeChanged NodeHasChildren Notification Paint QuadClick Resize SaveToFile SaveToStream ScrollView Select Selected SelectionCount SelectionIsHidden Selections SelectionVisible SetDragMode SetInsertMark SetInsertMarkAt SetOptions States StoreCurrentSelection TFindOption TFindOptions TopItem TripleClick UnlockSelectionChangeEvent UpdateDefaultItemHeight UpdateInsertMark WMHScroll WMKillFocus WMLButtonDown WMSetFocus WMVScroll WriteDebugReport WSRegisterClass
From TCustomControl (6)
From TWinControl (219)
AddControl AdjustClientRect AlignControls AllAutoSized AutoAdjustLayout AutoSizeDelayed AutoSizeDelayedHandle AutoSizeDelayedReport AutoSizePhases BeginUpdateBounds BoundsLockCount BroadCast Brush BrushCreated CachedClientHeight CachedClientWidth CalculatePreferredSize CanFocus CanSetFocus CanTab ChangeScale ChildClassAllowed ChildHandlesCreated ChildKey ChildSizing ClientRectNeedsInterfaceUpdate CMBiDiModeChanged CMBorderChanged CMDoubleBufferedChanged CMEnabledChanged CMEnter CMExit CMParentDoubleBufferedChanged CMShowHintChanged CMShowingChanged CMVisibleChanged CNChar CNKeyDown CNKeyUp CNSysKeyDown CNSysKeyUp ContainsControl ControlAtPos ControlCount ControlKeyDown ControlKeyUp Controls ControlsAligned CreateBrush CreateDockManager CreateHandle CreateParams CreateParented CreateParentedControl CreateSubClass CustomAlignInsertBefore CustomAlignPosition DefaultHandler DefWndProc DesignerDeleting DestroyHandle DialogChar DisableAlign DoAddDockClient DoAdjustClientRectChange DoAlignChildControls DoAllAutoSize DoAutoSize DoChildSizingChange DockClientCount DockClients DockDrop DockManager DockOver DockSite DoConstraintsChange DoDockClientMsg DoDockOver DoEnter DoExit DoFlipChildren DoFloatMsg DoGetDockCaption DoKeyDownBeforeInterface DoKeyPress DoKeyUpBeforeInterface DoRemainingKeyDown DoRemainingKeyUp DoRemoveDockClient DoSendBoundsToInterface DoSendShowHideToInterface DoSetBounds DoubleBuffered DoUnDock DoUndockClientMsg DoUTF8KeyPress EnableAlign EndUpdateBounds FinalizeWnd FindChildControl FindNextControl FixDesignFontsPPIWithChildren FixupTabList FlipChildren Focused FormEndUpdated GetAdjustedLogicalClientRect GetBorderStyle GetChildren GetChildrenRect GetClientOrigin GetClientRect GetControlIndex GetControlOrigin GetDeviceContext GetDockCaption GetEnumeratorControls GetEnumeratorControlsReverse GetMouseCapture GetParentHandle GetPreferredSizeClientFrame GetSiteInfo GetTabOrderList GetTextLen GetTopParentHandle Handle HandleAllocated HandleNeeded InsertControl IntfGetDropFilesTarget IntfUTF8KeyPress InvalidateBoundsRealized InvalidateClientRectCache InvalidatePreferredChildSizes IsClientHeightStored IsClientWidthStored IsControlMouseMsg IsFlipped IsResizing IsSpecialSubControl KeyDownAfterInterface KeyDownBeforeInterface KeyPress KeyUp KeyUpAfterInterface KeyUpBeforeInterface LockRealizeBounds MainWndProc NotifyControls OnAlignInsertBefore OnAlignPosition OnDockDrop OnDockOver OnGetDockCaption OnGetSiteInfo OnUnDock PaintControls PaintHandler PaintTo ParentDoubleBuffered ParentFormHandleInitialized ParentHandlesAllocated ParentWindow PerformTab RealGetText ReAlign RealizeBounds RealizeBoundsRecursive RealSetText ReloadDockedControl RemoveControl RemoveFocus Repaint ScaleBy ScaleControls ScrollBy ScrollBy_WS SelectFirst SelectNext SendDialogChar SendMoveSizeMessages SetBorderStyle SetBounds SetChildZPosition SetControlIndex SetDockManager SetFocus SetShape SetTempCursor ShowControl Showing UnlockRealizeBounds Update UpdateControlState UpdateDockCaption UpdateShowing UseDockManager UTF8KeyPress VisibleDockClientCount WindowHandle WMChar WMContextMenu WMDestroy WMEnter WMEraseBkgnd WMExit WMKeyDown WMKeyUp WMMove WMNotify WMShowWindow WMSize WMSysChar WMSysKeyDown WMSysKeyUp WMWindowPosChanged WndProc WriteLayoutDebugReport WSSetText
From TControl (308)
AccessibleDescription AccessibleName AccessibleRole AccessibleValue Action ActionChange ActionLink ActiveDefaultControlChanged AddHandler AddHandlerOnBeforeDestruction AddHandlerOnChangeBounds AddHandlerOnEnabledChanged AddHandlerOnEnabledChanging AddHandlerOnKeyDown AddHandlerOnMouseWheel AddHandlerOnResize AddHandlerOnVisibleChanged AddHandlerOnVisibleChanging AdjustSize AnchorAsAlign AnchorClient AnchoredControlCount AnchoredControls AnchorHorizontalCenterTo AnchorParallel AnchorSame AnchorSide AnchorSideBottom AnchorSideChanged AnchorSideLeft AnchorSideRight AnchorSideTop AnchorToCompanion AnchorToNeighbour AnchorVerticalCenterTo AssignTo AutoSize AutoSizing AutoSizingAll AutoSizingLockCount BaseBounds BaseParentClientSize BeforeDestruction BeforeDragStart BeginAutoSizing BeginDrag BiDiMode BoundsChanged BoundsRect BoundsRectForNewParent BringToFront CalculateDockSizes CanAutoSize Caption CaptureChanged CaptureMouseButtons ChangeBounds Changed CheckChildClassAllowed CheckNewParent CheckOnChangeBounds ClientHeight ClientOrigin ClientRect ClientToParent ClientToScreen ClientWidth CMChanged CMCursorChanged CMHintShow CMHitTest CMMouseEnter CMMouseLeave CMParentBiDiModeChanged CMParentColorChanged CMParentFontChanged CMParentShowHintChanged CMSysFontChanged CMTextChanged CNPreferredSizeChanged ColorIsStored ConstrainedResize ControlFontClass ControlOrigin ControlState ControlStyle ControlToScreen CreateAccessibleObject CreateControlBorderSpacing CreateFloatingDockSite Cursor DefineProperties DesktopFont DisableAutoSizing DoBorderSpacingChange DoCallKeyEventHandler DoCallMouseWheelEventHandler DoCallNotifyHandler Dock Docked DockOrientation DockTrackNoTarget DoContextPopup DoDock DoEndDock DoFixDesignFontPPI DoMouseDown DoMouseUp DoMouseWheelDown DoMouseWheelLeft DoMouseWheelRight DoMouseWheelUp DoOnChangeBounds DoOnParentHandleDestruction DoOnResize DoOnShowHint DoScaleFontPPI DoStartDock DragCanceled DragDrop Dragging EditingDone EnableAutoSizing EnabledChanged EnabledChanging EndAutoSizing EndDrag ExecuteCancelAction ExecuteDefaultAction FindSubComponent FixDesignFontsPPI Floating FloatingDockSiteClass ForeignAnchorSideChanged FormIsUpdating GetAccessibleObject GetAction GetActionLinkClass GetAnchorsDependingOnParent GetCachedText GetCanvasScaleFactor GetClientScrollOffset GetColorResolvingParent GetCursor GetDefaultColor GetDefaultDockCaption GetDefaultHeight GetDefaultWidth GetDockEdge GetEnabled GetFloating GetFloatingDockSiteClass GetLogicalClientRect GetMousePosFromMessage GetPalette GetParentBackground GetParentComponent GetPopupMenu GetPreferredSize GetRGBColorResolvingParent GetScrolledClientRect GetSidePosition GetTextBuf GetTopParent HandleObjectShouldBeVisible HasHelp HasParent Height HeightIsAnchored HelpContext HelpKeyword HelpType Hide Hint HostDockSite InitiateAction InvalidateControl InvalidatePreferredSize IsAParentAligning IsBorderSpacingInnerBorderStored IsCaptionStored IsControl IsControlVisible IsEnabled IsParentColor IsParentFont IsParentOf IsProcessingPaintMsg IsRightToLeft IsVisible Left LMCaptureChanged LoadedAll LRDockWidth ManualDock ManualFloat MouseCapture MouseEnter MouseInClient OnChangeBounds OnConstrainedResize OnEditingDone OnEndDock OnQuadClick OnStartDock OnTripleClick Parent ParentBackground ParentBiDiMode ParentDestroyingHandle ParentFontChanged ParentToClient Perform PositionDockRect ReadBounds ReadState Refresh RemoveAllHandlersOfObject RemoveHandler RemoveHandlerOnBeforeDestruction RemoveHandlerOnChangeBounds RemoveHandlerOnEnabledChanged RemoveHandlerOnEnabledChanging RemoveHandlerOnKeyDown RemoveHandlerOnMouseWheel RemoveHandlerOnResize RemoveHandlerOnVisibleChanged RemoveHandlerOnVisibleChanging ReplaceDockedControl RequestAlign Scale96ToFont Scale96ToForm Scale96ToScreen ScaleConstraints ScaleDesignToForm ScaleFontsPPI ScaleFontTo96 ScaleFontToScreen ScaleFormTo96 ScaleFormToDesign ScaleScreenTo96 ScaleScreenToFont ScreenToClient ScreenToControl SendToBack SessionProperties SetAction SetAlign SetAnchors SetAutoSize SetBiDiMode SetBoundsKeepBase SetCursor SetEnabled SetHint SetInitialBounds SetName SetParent SetParentBackground SetParentBiDiMode SetParentComponent SetTextBuf SetVisible SetZOrder ShouldAutoAdjust Show ShowHelp TBDockHeight Text TextChanged Top UndockHeight UndockWidth UpdateAnchorRules UpdateBaseBounds UpdateMouseCursor UpdateRolesForForm UseRightToLeftAlignment UseRightToLeftReading UseRightToLeftScrollBar VisibleChanged VisibleChanging Width WidthIsAnchored WindowProc WMCancelMode WMLButtonDBLCLK WMLButtonQuadCLK WMLButtonTripleCLK WMLButtonUp WMMButtonDBLCLK WMMButtonDown WMMButtonQuadCLK WMMButtonTripleCLK WMMButtonUp WMMouseHWheel WMMouseMove WMMouseWheel WMRButtonDBLCLK WMRButtonDown WMRButtonQuadCLK WMRButtonTripleCLK WMRButtonUp WMXButtonDBLCLK WMXButtonDown WMXButtonQuadCLK WMXButtonTripleCLK WMXButtonUp
From TLCLComponent (6)
DecLCLRefCount GetWSComponentClass IncLCLRefCount LCLRefCount NewInstance WidgetSetClass
From TComponent (63)
_AddRef _Release CanObserve ChangeName ComObject ComponentCount ComponentIndex Components ComponentState ComponentStyle DesignInfo DestroyComponents Destroying ExecuteAction FindComponent FreeNotification FreeOnRelease GetChildOwner GetChildParent GetDeltaStreams GetEnumerator GetIDsOfNames GetNamePath GetObservers GetOwner GetTypeInfo GetTypeInfoCount iicrGetComponent InsertComponent Invoke IsImplementorOf Loading Name ObserverAdded Observers OnGetDeltaStreams Owner PaletteCreated QueryInterface ReadDeltaState ReadDeltaStream ReferenceInterface RemoveComponent RemoveFreeNotification RemoveFreeNotifications SafeCallException SetAncestor SetChildOrder SetDesigning SetDesignInstance SetInline SetSubComponent ToString TToStringNameMode UpdateAction Updated UpdateRegistry Updating ValidateContainer ValidateInsert ValidateRename VCLComObject WriteState
From TPersistent (4)
Assign FPOAttachObserver FPODetachObserver FPONotifyObservers
From TObject (35)
AfterConstruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName QualifiedClassName StringMessageTable SystemHasExtendedRTTI UnitName
An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.
