[Overview][Constants][Types][Classes][Procedures and functions][Index] Reference for unit 'ComCtrls' (#lcl)

TTreeView

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

TTreeView is a control that displays a hierarchical list of items

Declaration

Source position: comctrls.pp line 2707

type TTreeView = class(TCustomTreeView)

published

  property Align;

  

Used to align the control to the top, bottom, left or right of its client.

  property Anchors;

  

The set of anchor definitions for this control

  property AutoExpand;

  

AutoExpand - automatically expand the tree when an item is selected

  property BorderSpacing;

  

Determines the border spacing for this control

  property BackgroundColor;

  

BackgroundColor for the treeview

  property BorderStyle;

  

BorderStyle - none, or single

  property BorderWidth;

  

Property to determine width of the window's border

  property Color;

  

Determine the colour for the current control

  property Constraints;

  

Determine Constraints (max and min height and width) for this control

  property DefaultItemHeight;

  

DefaultItemHeight - default height for items on the list

  property DragKind;

  

DragKind - what sort of dragging? Drag or Dock

  property DragCursor;

  

DragCursor - the style of cursor to be used during the Drag process

  property DragMode;

  

DragMode - whether manual or automatic

  property Enabled;

  

Whether the control is Enabled (read/write). If not, it usually appears 'greyed-out'

  property ExpandSignType;

  

ExpandSignType - the symbols to denote whether a list is expanded or collapsed; default is plus or minus

  property Font;

  

The font to be used for text in this control (read/write).

  property HideSelection;

  

HideSelection - the selected items are to be hidden

  property HotTrack;

  

HotTrack - the property whereby the item under the mouse pointer becomes emphasised

  property Images;

  

The Bitmap image associated with each item in the display

  property Indent;

  

Indent - the amount by which each successive branching level is to be indented

  property MultiSelect;

  property MultiSelectStyle;

  property ParentColor;

  

ParentColor - should the control have the same colour as the parent? Default is true

  property ParentFont;

  

ParentFont - should the control use the same font as the parent? Default is true

  property ParentShowHint;

  

ParentShowHint - does the control adopt the same hinting behaviour as its parent? Default is true

  property PopupMenu;

  

PopupMenu - a context-sensitive menu that pops up when the right mouse button is clicked over this control

  property ReadOnly;

  

ReadOnly - if True, the TreeView can only be observed, and not Written to or changed. Default False

  property RightClickSelect;

  

RightClickSelect - if True, a Right Click selects an Item. Default False

  property RowSelect;

  

RowSelect - if True, a row is selected

  property ScrollBars;

  

ScrollBars - the style of scroll bars for the treeview display

  property SelectionColor;

  

SelectionColor - the colour to be used for the selected nodes, to distinguish them from the others

  property ShowButtons;

  

ShowButtons - if True, buttons are displayed

  property ShowHint;

  

Flag to determine: Is hint to be displayed for this control?

  property ShowLines;

  

ShowLines - show the connecting lines of the tree structure

  property ShowRoot;

  

ShowRoot - if True, the root of the tree structure is displayed

  property SortType;

  

SortType - the way the items are to be sorted: None, by Data, by Text or Both

  property StateImages;

  

StateImages - the list of images to denote state of the tree (expanded, contracted etc)

  property TabOrder;

  

The place this control occupies in the list of tabs

  property TabStop;

  

Is the control in the sequence of controls accessed by successive presses of the Tab key?

  property Tag;

  

  property ToolTips;

  

ToolTips - if True (default), pop-up tool tips are to be shown

  property Visible;

  

Visible - can the control be seen?

  property OnAddition;

  property OnAdvancedCustomDraw;

  

OnAdvancedCustomDraw - event handler for advanced custom drawing

  property OnAdvancedCustomDrawItem;

  

OnAdvancedCustomDrawItem - event handleer for advanced custom drawing item

  property OnChange;

  

OnChange - specialised event handler for a change in the TreeView

  property OnChanging;

  

OnChanging - specialised event handler while TreeView is being changed

  property OnClick;

  

Event Handler for mouse click

  property OnCollapsed;

  

OnCollapsed - specialised event handler when part of the tree is collapsed

  property OnCollapsing;

  

OnCollapsing - specialised event handler while part of the tree is being collapsed

  property OnCompare;

  

OnCompare - specialised event handler for comparisons within the TreeView

  property OnContextPopup;

  

Event handler to supply information when a context-sensitive pop-up menu is required

  property OnCreateNodeClass;

  property OnCustomCreateItem;

  

OnCustomCreateItem - event handler for custom item creation

  property OnCustomDraw;

  

OnCustomDraw - event handler for custom drawing

  property OnCustomDrawItem;

  

OnCustomDrawItem - event handler for custom drawing item

  property OnDblClick;

  

Event Handle for mouse double-click

  property OnDeletion;

  

OnDeletion - specialised event handler for deletion of node(s) from the tree

  property OnDragDrop;

  

Event handler for the drop of a control onto this control.

  property OnDragOver;

  

Event handler for the case when a control is dragged over another control

  property OnEdited;

  

OnEdited - specialised event handler when the TreeView has been edited

  property OnEditing;

  

OnEditing - event handler during the editing process

  property OnEditingEnd;

  property OnEndDrag;

  

Event handler for the end of a dragging process

  property OnEnter;

  

OnEnter - event handler for when the mouse enters the control, and the control receives focus

  property OnExit;

  

OnExit - event handler for when the mouse leaves the control and it loses focus

  property OnExpanded;

  

OnExpanded - specialised event handler when a TreeView has been expanded

  property OnExpanding;

  

OnExpanding - specialised event handler while a TreeView is being expanded

  property OnGetImageIndex;

  

OnGetImageIndex - event handler for finding the index of an image

  property OnGetSelectedIndex;

  

OnGetSelectedIndex - event handler for finding index of selected item

  property OnKeyDown;

  

OnKeyDown - event handler for instance when key is down while control has focus

  property OnKeyPress;

  

OnKeyPress - event controller for a key being pressed while the control has focus. To properly handle national chars use UTF8KeyPress instead.

  property OnKeyUp;

  

OnKeyUp - event handler for instance when a key is up (not pressed) while the control has focus

  property OnMouseDown;

  

Event handler for when a mouse button is pressed down

  property OnMouseEnter;

  property OnMouseLeave;

  property OnMouseMove;

  

Event handler for mouse movement within the current control

  property OnMouseUp;

  

Event handler for when the mouse button is released, ie "up"

  property OnSelectionChanged;

  

OnSelectionChanged - event handler for a change in the selection

  property OnShowHint;

  

Event Handler when a hint needs to be shown

  property OnStartDrag;

  

Event handler for start of dragging operation

  property OnUTF8KeyPress;

  

UTF8KeyPress - event controller for a key being pressed while the control has focus.

  property Options;

  

The set of Options for displaying the tree view

  property Items;

  

Items - the collection of TreeNodes that comprise the TreeView

  property TreeLineColor;

  

TreeLineColor - the colour to be used for the lines showing the tree structure

  property TreeLinePenStyle;

  

TreeLinePenStyle - the pen style for drawing lines on the tree

  property ExpandSignColor;

  

ExpandSignColor - the colour to be used for the expand/collapse symbols

end;

Inheritance

TTreeView

  

TTreeView is a control that displays a hierarchical list of items

|

TCustomTreeView

  

TCustomTreeView - ancestor class for TTreeView

|

TCustomControl

  

TCustomControl - a base class for many window controls

|

TWinControl

|

TControl

|

TLCLComponent

  

TLCLComponent - base class for LCL components

|

TComponent,IUnknown,IInterfaceComponentReference

|

TPersistent

|

TObject

Description

Use a TTreeView to display a hierarchical list of items. Items are shown by their caption and an optional bitmap.

See also

#lcl.stdctrls.HowToUseStdCtrls

  

How to use StdCtrls, ComCtrls or ExtCtrls

#LCL.ComCtrls.TCustomTreeView

  

TCustomTreeView - ancestor class for TTreeView

The latest version of this document can be found at lazarus-ccr.sourceforge.net.