The currently selected tree items.


Usage

Set_Property(OLECtrlEntID, "OLE.SelectedItems", StringValue)

Values

StringValue can be any string meeting the following format requirements:

Syntax: @FM delimited list of item keys

Default: ""

Remarks

The SelectedItems property gets and sets the current selection. The property is formatted as an @FM delimited array of item keys. The array is in the order that items were selected, not necessarily in the order they appear in the tree. To get the current selection, simply read this property. You can use the results in most of the tree control methods.

To programmatically set the selection, simply pass a new @FM delimited array of item keys.

This property does not recognize the SelectBehavior property. So, even if the selection behavior is set to single selection, you can still select multiple items using this property.

NOTE: This property has an alias: SelPos. In other words, you can use either the SelectedItems or SelPos properties to get or set the currently select items.

Example

// Delete the currently selected items 
SelectedItems = Get_Property(@Window:".OLE_TREE", "OLE.SelectedItems") 
Send_Message(@Window:".OLE_TREE", "OLE.RemoveItems", SelectedItems) 

// Select three items 
SelectedItems = "Item1":@FM:"Item2":@FM:"Item3" 
Set_Property(@Window:".OLE_TREE", "OLE.SelectedItems", SelectedItems)

See Also

FocusItemTopItemSelectBehavior

  • No labels