ListSelection Property, SftTree Object


	SftTree.ListSelection Property	Softel vdm, Inc.

Returns the selected item.

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

Syntax

Get
	VB.NET	ItemIndex = object.get_ListSelection(ByVal SelectionIndex As Object) As Integer
	VB	ItemIndex = object.ListSelection(ByVal SelectionIndex As Variant) As Long
	C#.NET	int ItemIndex = object.get_ListSelection(object SelectionIndex);
	VC++	long ItemIndex = object->ListSelection[const _variant_t& SelectionIndex]; long ItemIndex = object->GetListSelection(const _variant_t& SelectionIndex);
	C	HRESULT object->get_ListSelection(VARIANT SelectionIndex, long* ItemIndex);
	Delphi	ItemIndex := object.ListSelection[SelectionIndex : OleVariant] : Integer;

object

A SftTree object.

SelectionIndex

The entry number of the selected item index to return. Visual Basic: If this parameter is omitted, the index of the first (or only) selected item is returned.

ItemIndex

Returns the item index of the nth selected item as specified by SelectionIndex. -1 is returned if no item is selected.

Comments

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

The ListSelection property returns the selected item.

The ListSelection property returns the zero-based index of the nth selected item as specified by SelectionIndex. In a single selection tree control (see Items.MultiSelect property), SelectionIndex may be omitted or can be specified as 0. The first (and only) selected item is returned or -1 if no item is selected.

In a multiple selection tree control, the index of all selected items can be retrieved. The Items.SelectionCount property returns the number of selected items. The Items.SelectionGroupStart and Items.SelectionGroupEnd properties are used to retrieve groups of selected items.