Hide

SftTree/OCX 7.5 - ActiveX Tree Control

Display
Print

ItemExpand Property, SftTree Object

Defines whether an item is expanded or collapsed.

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

Syntax

Get

VB.NETBoolean = object.get_ItemExpand(ByVal ItemIndex As Integer) As Boolean
VBBoolean = object.ItemExpand(ByVal ItemIndex As Long) As Boolean
C#.NETbool Boolean = object.get_ItemExpand(int ItemIndex);
VC++VARIANT_BOOL Boolean = object->ItemExpand[long ItemIndex];
VARIANT_BOOL Boolean = object->GetItemExpand(long ItemIndex);
CHRESULT object->get_ItemExpand(long ItemIndex, VARIANT_BOOL* Boolean);

Put

VB.NETobject.set_ItemExpand(ByVal ItemIndex As Integer, ByVal Boolean As Boolean)
VBobject.ItemExpand(ByVal ItemIndex As Long) = Boolean As Boolean
C#.NETvoid object.set_ItemExpand(int ItemIndex, bool Boolean);
VC++VARIANT_BOOL object->ItemExpand[long ItemIndex] = Boolean;
void object->PutItemExpand(long ItemIndex, VARIANT_BOOL Boolean);
CHRESULT object->put_ItemExpand(long ItemIndex, VARIANT_BOOL Boolean);

object

A SftTree object.

ItemIndex

The zero-based index of the item to be expanded or collapsed.

Boolean

Defines whether the item is expanded or collapsed.

BooleanDescription
TrueThe item is expanded.
FalseThe item is collapsed.

Comments

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

The ItemExpand property defines whether an item is expanded or collapsed.

When setting ItemExpand to True, only an item's immediate dependents are made visible. Dependents of items that are made visible are not automatically made visible. The Items.Expand and Item.Expand method can be used to expand all immediate and indirect dependents.

If an item is already expanded when setting ItemExpand to True, the item remains unchanged. It does not hide any indirect dependents. To make sure that an item's indirect dependents are not shown, ItemExpand can be set to False first, which collapses the item (and all dependents), followed by setting ItemExpand to True. Now only immediate dependents are visible.

An item has to be currently shown to be expanded or collapsed. If the item is not shown, its state cannot be modified. The Item.Shown property can be used to determine if an item is shown.

The Item.DependentCount property can be used to determine if an item can be expanded. If an item doesn't have any dependents, it is a leaf item and cannot be expanded. However, it is not an error to use ItemExpand with a leaf item.

The ItemExpand property does not preserve or restore the expand/collapse state of its dependent items. Use Items.Expand, Item.Expand, Items.Collapse and Item.Collapse to preserve or restore this information.

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

See Also SftTree Object | Object Hierarchy


Last Updated 08/13/2020 - (email)
© 2022 Softel vdm, Inc.