SftTree/OCX 7.0

SftTree.InsertItem Method

Softel vdm, Inc.

Inserts a new item.

Deprecated - Provided for compatibility with earlier versions only - Use Items.Insert instead

Syntax       

VB.NET

ItemIndex = object.InsertItem(ByVal AtIndex As Integer, ByVal Text As String)  As Integer

VB

ItemIndex = object.InsertItem(ByVal AtIndex As Long, ByVal Text As String)  As Long

C#.NET

int ItemIndex = object.InsertItem(int AtIndex, string Text);

VC++

long ItemIndex = object->InsertItem(long AtIndex, _bstr_t Text);

C

HRESULT object->raw_InsertItem(long AtIndex, BSTR Text, long* ItemIndex);

Delphi

ItemIndex := object.InsertItem(AtIndex : Integer; Text : WideString)   : Integer;

object

A SftTree object.

AtIndex

The zero-based index of the position where the item will be inserted.  If -1 is specified, the item is added at the end of the list.

Text

The text to be used for the item's first (or only) column.

ItemIndex

Returns the zero-based index of the newly inserted item.

Comments

Deprecated - Provided for compatibility with earlier versions only - Use Items.Insert instead

The InsertItem method inserts a new item.

By default, new items are added at level 0.  Use the Item.Level property to change an item's level.  If many items have to be added, the BulkUpdate property can be used to indicate a mass-update, which is significantly faster.

Once an item has been added, the Cell.Text property can be used to change the text for any of the available columns.

Items can be added at the end of the list by using the Items.Add method.  Items can be deleted using the Items.Remove method.

When a tree control is populated using Items.Add or Items.Insert, the Items.RecalcHorizontalExtent method can be used to have the tree control calculate the optimal horizontal scrolling area so scroll bars are enabled, depending on the Scrollbars property.

If a parent item is collapsed, subsequently adding child items will automatically expand the item.

See Also  SftTree Object | Object Hierarchy


Feedback / comments / error reports for this topic
© 2015 - Softel vdm, Inc. - www.softelvdm.com