Vcl.Outline.TCustomOutline.Add

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function Add(Index: LongInt; const Text: string): LongInt;

C++

int __fastcall Add(int Index, const System::UnicodeString Text);

Properties

Type Visibility Source Unit Parent
function public
Vcl.Outline.pas
Vcl.Outline.hpp
Vcl.Outline TCustomOutline

Description

Adds a node to the outline.

Use Add to add a TOutlineNode object to the outline. Text specifies the Text property value of the new node.

Index specifies where to add the new node. The new node is positioned in the outline as the last sibling of the node identified by Index. To add nodes to the beginning of the outline, specify zero (0) as the Index parameter.

Nodes that appear after the new node are moved down one row and reindexed in the Items property array with valid Index values. If BeginUpdate has been called, the Items array is not reindexed until the EndUpdate method is called.

Add returns the Index property of the new node.

See Also