A group's selected items.

Usage

Set_Property(OLECtrlEntID, "OLE.GroupSelection[group]", Array)

Values

Array has the following structure:

PosNameTypeDescriptionDefault
<1>Selected ItemIntegerIndex to a selected item within the group""

Indices

IndexDescription
groupIndex to an existing group

Remarks

The GroupSelection property is the list of a group's selected items. This property is an alternative to the Selection property and is useful when you only need the selection states of a particular group's items.

The property is an @FM delimited array of item indexes. If there are no selected items, then the property will be empty. You may use this property to set the selected items for a group.

Selection will return nothing if either field of the SelectBehavior property is set to "None". Nor can items be programmatically selected in this case.

Example

// Get the selected items for a single group and determine how many there are 
GroupSelItems = Get_Property(@Window:".OLE_SHORTCUT", "OLE.GroupSelection[1]") 
NumGroupSelItems = Count(GroupSelItems, @FM) + (GroupSelItems NE "") 

// Set selected items for a group 
GroupSelItems = "1":@FM:"2":@FM:"3" 
Set_Property(@Window:".OLE_SHORTCUT", "OLE.GroupSelection[2]", GroupSelItems) 

// Remove a group's selection 
Set_Property(@Window:".OLE_SHORTCUT", "OLE.GroupSelection[3]", "") 

// Remove all groups' selections 
Set_Property(@Window:".OLE_SHORTCUT", "OLE.GroupSelection[All]", "")

See Also

SelectionSelectBehavior

  • No labels