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

type TTreeView = class(TCustomTreeView) end;

published

  property Align: TAlign;

  

Specifies the placement of the control inside its Parent.

  property Anchors: TAnchors;

  

The set of anchor definitions for this control.

  property AutoExpand: Boolean;

  property BorderSpacing: TControlBorderSpacing;

  

Determines the inner and outer border spacing for this control.

  property BackgroundColor: TColor;

  property BorderStyle: TBorderStyle;

  

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

  property BorderWidth: TBorderWidth;

  

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

  property Color: TColor;

  

The background color of the control.

  property Constraints: TSizeConstraints;

  

The minimal and maximal Width and Height of this control.

  property DefaultItemHeight: Integer;

  property DragKind: TDragKind;

  

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

  property DragCursor: TCursor;

  

The cursor shape shown while the control is dragged.

  property DragMode: TDragMode;

  

Allows the user to drag the control.

  property Enabled: Boolean;

  

Determines whether the control reacts on mouse or keyboard input.

  property ExpandSignColor: TColor;

  property ExpandSignSize: Integer;

  property ExpandSignType: TTreeViewExpandSignType;

  property Font: TFont;

  

The font to be used for text display in this control.

  property HideSelection: Boolean;

  property HotTrack: Boolean;

  property Images: TCustomImageList;

  property Indent: Integer;

  property MultiSelect: Boolean;

  property MultiSelectStyle: TMultiSelectStyle;

  property ParentColor: Boolean;

  

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

  property ParentFont: Boolean;

  

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

  property ParentShowHint: Boolean;

  

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

  property PopupMenu: TPopupMenu;

  

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

  property ReadOnly: Boolean;

  property RightClickSelect: Boolean;

  property RowSelect: Boolean;

  property ScrollBars: TScrollStyle;

  property SelectionColor: TColor;

  property SelectionFontColor: TColor;

  property SelectionFontColorUsed: Boolean;

  property SeparatorColor: TColor;

  property ShowButtons: Boolean;

  property ShowHint: Boolean;

  

Enables the Hint display.

  property ShowLines: Boolean;

  property ShowRoot: Boolean;

  property SortType: TSortType;

  property StateImages: TCustomImageList;

  property TabOrder: TTabOrder;

  

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

  property TabStop: Boolean;

  

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

  property Tag;

  

  property ToolTips: Boolean;

  property Visible: Boolean;

  

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

  property OnAddition: TTVExpandedEvent;

  property OnAdvancedCustomDraw: TTVAdvancedCustomDrawEvent;

  

OnAdvancedCustomDraw - event handler for advanced custom drawing

  property OnAdvancedCustomDrawItem: TTVAdvancedCustomDrawItemEvent;

  

OnAdvancedCustomDrawItem - event handleer for advanced custom drawing item

  property OnChange: TTVChangedEvent;

  

OnChange - specialised event handler for a change in the TreeView

  property OnChanging: TTVChangingEvent;

  

OnChanging - specialised event handler while TreeView is being changed

  property OnClick: TNotifyEvent;

  

Notification handler for mouse clicks.

  property OnCollapsed: TTVExpandedEvent;

  

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

  property OnCollapsing: TTVCollapsingEvent;

  

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

  property OnCompare: TTVCompareEvent;

  

OnCompare - specialised event handler for comparisons within the TreeView

  property OnContextPopup: TContextPopupEvent;

  

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

  property OnCreateNodeClass: TTVCreateNodeClassEvent;

  property OnCustomCreateItem: TTVCustomCreateNodeEvent;

  

OnCustomCreateItem - event handler for custom item creation

  property OnCustomDraw: TTVCustomDrawEvent;

  

OnCustomDraw - event handler for custom drawing

  property OnCustomDrawItem: TTVCustomDrawItemEvent;

  

OnCustomDrawItem - event handler for custom drawing item

  property OnCustomDrawArrow: TTVCustomDrawArrowEvent;

  property OnDblClick: TNotifyEvent;

  

Event Handler for double mouse clicks.

  property OnDeletion: TTVExpandedEvent;

  

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

  property OnDragDrop: TDragDropEvent;

  

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

  property OnDragOver: TDragOverEvent;

  

Event handler for a control being dragged over this control.

  property OnEdited: TTVEditedEvent;

  

OnEdited - specialised event handler when the TreeView has been edited

  property OnEditing: TTVEditingEvent;

  

OnEditing - event handler during the editing process

  property OnEditingEnd: TTVEditingEndEvent;

  property OnEndDrag: TEndDragEvent;

  

Notification handler for the end of a dragging operation.

  property OnEnter: TNotifyEvent;

  

Handler for control receiving the focus.

  property OnExit: TNotifyEvent;

  

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

  property OnExpanded: TTVExpandedEvent;

  

OnExpanded - specialised event handler when a TreeView has been expanded

  property OnExpanding: TTVExpandingEvent;

  

OnExpanding - specialised event handler while a TreeView is being expanded

  property OnGetImageIndex: TTVExpandedEvent;

  

OnGetImageIndex - event handler for finding the index of an image

  property OnGetSelectedIndex: TTVExpandedEvent;

  

OnGetSelectedIndex - event handler for finding index of selected item

  property OnKeyDown: TKeyEvent;

  

Handler for keyboard key pressed.

  property OnKeyPress: TKeyPressEvent;

  

Handler for a character entered by the user.

  property OnKeyUp: TKeyEvent;

  

Handler for keyboard key released.

  property OnMouseDown: TMouseEvent;

  

Event handler for mouse button going down.

  property OnMouseEnter: TNotifyEvent;

  property OnMouseLeave: TNotifyEvent;

  property OnMouseMove: TMouseMoveEvent;

  

Event handler for mouse movement within the control.

  property OnMouseUp: TMouseEvent;

  

Event handler for mouse button going up.

  property OnMouseWheel: TMouseWheelEvent;

  property OnMouseWheelDown: TMouseWheelUpDownEvent;

  property OnMouseWheelUp: TMouseWheelUpDownEvent;

  property OnNodeChanged: TTVNodeChangedEvent;

  property OnResize: TNotifyEvent;

  property OnSelectionChanged: TNotifyEvent;

  

OnSelectionChanged - event handler for a change in the selection

  property OnShowHint: TControlShowHintEvent;

  

Event Handler when a hint shall be shown.

  property OnStartDrag: TStartDragEvent;

  

Event handler for the start of a dragging operation.

  property OnUTF8KeyPress: TUTF8KeyPressEvent;

  

Handler for a character entered by the user.

  property Options: TTreeViewOptions;

  property Items: TTreeNodes;

  

Collection of tree-items which is the content of control. Has type TTreeNodes.

  property TreeLineColor: TColor;

  property TreeLinePenStyle: TPenStyle;

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

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