SftTree/OCX 7.0

SftTree.ItemExpandable Property

Softel vdm, Inc.

Defines whether an item is expandable.

Deprecated - Provided for compatibility with earlier versions only - Use Item.Expandable instead

Syntax       

Get

VB.NET

Expandable = object.get_ItemExpandable(ByVal ItemIndex As Integer)  As Boolean

VB

Expandable = object.ItemExpandable(ByVal ItemIndex As Long)  As Boolean

C#.NET

bool Expandable = object.get_ItemExpandable(int ItemIndex);

VC++

VARIANT_BOOL Expandable = object->ItemExpandable[long ItemIndex];
VARIANT_BOOL Expandable = object->GetItemExpandable(long ItemIndex);

C

HRESULT object->get_ItemExpandable(long ItemIndex, VARIANT_BOOL* Expandable);

Delphi

Expandable := object.ItemExpandable[ItemIndex : Integer]   : WordBool;

Put

VB.NET

object.set_ItemExpandable(ByVal ItemIndex As Integer, ByVal Expandable As Boolean)

VB

object.ItemExpandable(ByVal ItemIndex As Long) = Expandable  As Boolean

C#.NET

void object.set_ItemExpandable(int ItemIndex, bool Expandable);

VC++

VARIANT_BOOL object->ItemExpandable[long ItemIndex] = Expandable;
void object->PutItemExpandable(long ItemIndex, VARIANT_BOOL Expandable);

C

HRESULT object->put_ItemExpandable(long ItemIndex, VARIANT_BOOL Expandable);

Delphi

object.ItemExpandable[ItemIndex : Integer] := Expandable   : WordBool;

object

A SftTree object.

ItemIndex

The zero-based index of the item to be made Expandable.

Expandable

Defines whether the item is Expandable.

Boolean

Description

True

The item is Expandable.

False

The item is not Expandable.

Comments

Deprecated - Provided for compatibility with earlier versions only - Use Item.Expandable instead

The ItemExpandable property defines whether an item is Expandable.

Normally, only a parent item (with dependents) is Expandable.  An Expandable item displays an expand/collapse button and other attributes, such as the Items.ItemImageExpandable graphic.

A leaf item can be made a “temporary” parent item by setting the item's ItemExpandable property to True.  The item now displays an expand/collapse button and other attributes, such as the Items.ItemImageExpandable graphic.  The item can now also generate an ItemClick event to expand the item.  The application can then add child items as the user expands this “temporary” parent item, making it into a real parent item.

When setting the ItemExpandable property, an item's dependents are always removed, unless the item is already expanded.

If an item's ItemExpandable property is set to False, the item is collapsed (and its dependents are removed).

If an item is already expanded or has dependents when setting ItemExpandable to True, the item remains unchanged.  It is not expanded.

See Also  SftTree Object | Object Hierarchy


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