|
Extends ManagedObject. Extends SeSSimulatedObject.
Behavior Pattern: ManagedObjectListBoxSelectableBehavior
Property Summary
Property
|
Description
|
Getter
|
Setter
|
ItemCount
|
Number of items.
|
GetItemCount
|
|
ItemIndexByName
|
Returns item index by its name.
|
GetItemIndexByName
|
|
ItemNameByIndex
|
Returns item name by its index.
|
GetItemNameByIndex
|
|
SelectedIndex
|
Index of the selected element of the object.
|
GetSelectedIndex
|
SetSelectedIndex
|
SelectedIndices
|
Returns string of indexes delimited by separator or array of indexes of selected elements.
|
GetSelectedIndices
|
|
SelectedItems
|
Text of all the selected items in a single string.
|
GetSelectedItems
|
|
SelectedText
|
Text of the selected item in a single string.
|
GetSelectedText
|
|
SelectionCount
|
Number of selected items.
|
GetSelectionCount
|
|
Action Summary
Property Detail
ItemCount
Number of items.
Accessors: GetItemCount
ItemIndexByName
Returns item index by its name. 'false' if name is not found.
Accessors: GetItemIndexByName
ItemNameByIndex
Returns item name by its index.'false' if name is not found.
Accessors: GetItemNameByIndex
SelectedIndex
Index of the selected element of the object.
Accessors: GetSelectedIndex, SetSelectedIndex
SelectedIndices
Returns string of indexes delimited by separator or array of indexes of selected elements.
Accessors: GetSelectedIndices
SelectedItems
Text of all the selected items in a single string. Items are divided by ';' separator.
Accessors: GetSelectedItems
SelectedText
Text of the selected item in a single string.
Accessors: GetSelectedText
SelectionCount
Number of selected items.
Accessors: GetSelectionCount
Action Detail
DoAddSelection(items, separator, itemsType)
Extends selection.
Parameters:
Name
|
Type
|
Description
|
items
|
array |
string
|
Can be one of the following:
1. Number, index of an item.
2. String, item names delimited with separator.
3. String, item indexes delimited with separator.
4. Array of item names.
5. Array of item indexes.
|
separator
|
string
|
Separator
Optional, Default: ;.
|
itemsType
|
string
|
If it is 'name' and 'items' parameter is of Stringtype then 'items' parameter is treated as separated item names. If it is'index' and 'items' parameter is of String type then'items' parameter istreated as separated item indexes. If any other value is passed as 'itemsType'the behavior is undefined.
Optional.
|
Returns:
'true' if success, 'false' otherwise.
DoClearSelection()
Clears selection.
Returns:
'true' if success, 'false' otherwise.
DoRemoveSelection(items, separator, itemsType)
Removes selection from specified items.
Parameters:
Name
|
Type
|
Description
|
items
|
array |
string
|
Can be one of the following:
1. Number, index of an item.
2. String, item names delimited with separator.
3. String, item indexes delimited with separator.
4. Array of item names.
5. Array of item indexes.
|
separator
|
string
|
Separator
Optional, Default: ;.
|
itemsType
|
string
|
If it is 'name' and 'items' parameter is of Stringtype then 'items' parameter is treated as separated item names. If it is'index' and 'items' parameter is of String type then'items' parameter istreated as separated item indexes. If any other value is passed as 'itemsType'the behavior is undefined.
Optional.
|
Returns:
'true' if success, 'false' otherwise.
DoSelectItem(items, separator, itemsType)
Selects items of this object. First it clears existing selection.
Parameters:
Name
|
Type
|
Description
|
items
|
array |
string
|
Can be one of the following:
1. Number, index of an item.
2. String, item names delimited with separator.
3. String, item indexes delimited with separator.
4. Array of item names.
5. Array of item indexes.
|
separator
|
string
|
Separator
Optional, Default: ;.
|
itemsType
|
string
|
If it is 'name' and 'items' parameter is of Stringtype then 'items' parameter is treated as separated item names. If it is'index' and 'items' parameter is of String type then'items' parameter istreated as separated item indexes. If any other value is passed as 'itemsType'the behavior is undefined.
Optional.
|
Returns:
'true' if success, 'false' otherwise.
|