[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 3341

type TTreeView = class(TCustomTreeView)

published

  property Align;

  

Specifies the placement of the control inside its Parent.

  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 inner and outer border spacing for this control.

  property BackgroundColor;

  

BackgroundColor for the treeview

  property BorderStyle;

  

Allows to show a border (line) around the control,

  property BorderWidth;

  

Width of the Border around the control; default is zero.

  property Color;

  

The background color of the control.

  property Constraints;

  

The minimal and maximal Width and Height of this control.

  property DefaultItemHeight;

  

DefaultItemHeight - default height for items on the list

  property DragKind;

  

The operation when the control is dragged - Drag or Dock.

  property DragCursor;

  

The cursor shape shown while the control is dragged.

  property DragMode;

  

Allows the user to drag the control.

  property Enabled;

  

Determines whether the control reacts on mouse or keyboard input.

  property ExpandSignColor;

  

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

  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 display in this control.

  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;

  

If true, the Color of the control will be the same as the one from the Parent. Default is true.

  property ParentFont;

  

If true, the Font of the control will be the same as the one from the Parent. Default is true.

  property ParentShowHint;

  

If true, the value of ShowHint for the control will be the same as the one from the Parent. Default is true.

  property 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;

  

Enables the Hint display.

  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;

  

Determines the sequence of controls, reachable when the user presses the Tab key.

  property TabStop;

  

Allows the user to navigate to this control, by pressing the Tab key.

  property Tag;

  

  property ToolTips;

  

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

  property Visible;

  

Allows to show or hide the control, and all of its children.

  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;

  

Notification handler for mouse clicks.

  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;

  

Invoked when a context-sensitive pop-up menu is requested.

  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 Handler for double mouse clicks.

  property OnDeletion;

  

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

  property OnDragDrop;

  

This handler determines the action on an drop onto this control, in a drag-drop operation.

  property OnDragOver;

  

Event handler for a control being dragged over this 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;

  

Notification handler for the end of a dragging operation.

  property OnEnter;

  

Handler for control receiving the focus.

  property OnExit;

  

Handler for control loosing the focus. This is a good place for checking the finished user input.

  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;

  

Handler for keyboard key pressed.

  property OnKeyPress;

  

Handler for a character entered by the user.

  property OnKeyUp;

  

Handler for keyboard key released.

  property OnMouseDown;

  

Event handler for mouse button going down.

  property OnMouseEnter;

  property OnMouseLeave;

  property OnMouseMove;

  

Event handler for mouse movement within the control.

  property OnMouseUp;

  

Event handler for mouse button going up.

  property OnSelectionChanged;

  

OnSelectionChanged - event handler for a change in the selection

  property OnShowHint;

  

Event Handler when a hint shall be shown.

  property OnStartDrag;

  

Event handler for the start of a dragging operation.

  property OnUTF8KeyPress;

  

Handler for a character entered by the user.

  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

end;

Inheritance

TTreeView

  

TTreeView is a control that displays a hierarchical list of items

|

TCustomTreeView

  

TCustomTreeView - ancestor class for TTreeView

|

TCustomControl

  

The base class for windowed controls which paint themselves.

|

TWinControl

  

The base class for controls which can contain other (child) controls.

|

TControl

  

The base class for visible controls.

|

TLCLComponent

  

The base class for LCL components associated with widgets.

|

TComponent

?

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