ManagedListBox¶
Managed ListBox.
UI element class: System.Windows.Forms.ListBox
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¶
| Action | Description |
|---|---|
| DoAddSelection | Extends selection. |
| DoClearSelection | Clears selection. |
| DoRemoveSelection | Removes selection from specified items. |
| DoSelectItem | Selects items of this object. |
Property Detail¶
ItemCount¶
Number of items.
Type: number
Accessors: GetItemCount
value = SeS('SomeManagedListBox').GetItemCount()
ItemIndexByName¶
Returns item index by its name. 'false' if name is not found.
Getter Parameters:
| Name | Type | Description |
|---|---|---|
| name | string |
Type: number|boolean
Accessors: GetItemIndexByName
value = SeS('SomeManagedListBox').GetItemIndexByName(name)
ItemNameByIndex¶
Returns item name by its index.'false' if name is not found.
Getter Parameters:
| Name | Type | Description |
|---|---|---|
| index | number | Index of the item |
Type: string|boolean
Accessors: GetItemNameByIndex
value = SeS('SomeManagedListBox').GetItemNameByIndex(index)
SelectedIndex¶
Index of the selected element of the object.
Type: number
Accessors: GetSelectedIndex, SetSelectedIndex
value = SeS('SomeManagedListBox').GetSelectedIndex()
SeS('SomeManagedListBox').SetSelectedIndex(value)
SelectedIndices¶
Returns string of indexes delimited by separator or array of indexes of selected elements.
Getter Parameters:
| Name | Type | Description |
|---|---|---|
| asArray | boolean | If set to true, function returns an array. |
| separator | string | Separator character. Possible values: ";", ",", "\", "/" Optional, Default: ";". |
Type: string
Accessors: GetSelectedIndices
value = SeS('SomeManagedListBox').GetSelectedIndices(asArray, separator)
SelectedItems¶
Text of all the selected items in a single string. Items are divided by ';' separator.
Type: string
Accessors: GetSelectedItems
value = SeS('SomeManagedListBox').GetSelectedItems()
SelectedText¶
Text of the selected item in a single string.
Type: string
Accessors: GetSelectedText
value = SeS('SomeManagedListBox').GetSelectedText()
SelectionCount¶
Number of selected items.
Type: number
Accessors: GetSelectionCount
value = SeS('SomeManagedListBox').GetSelectionCount()
Action Detail¶
DoAddSelection¶
Extends selection.
SeS('SomeManagedListBox').DoAddSelection(items, separator, itemsType)
Parameters:
| Name | Type | Description |
|---|---|---|
| items | number | string | array | 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 character. Possible values: ";", ",", "\", "/" 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:
boolean: 'true' if success, 'false' otherwise.
DoClearSelection¶
Clears selection.
SeS('SomeManagedListBox').DoClearSelection()
Returns:
boolean: 'true' if success, 'false' otherwise.
DoRemoveSelection¶
Removes selection from specified items.
SeS('SomeManagedListBox').DoRemoveSelection(items, separator, itemsType)
Parameters:
| Name | Type | Description |
|---|---|---|
| items | number | string | array | 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 character. Possible values: ";", ",", "\", "/" 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:
boolean: 'true' if success, 'false' otherwise.
DoSelectItem¶
Selects items of this object. First it clears existing selection.
SeS('SomeManagedListBox').DoSelectItem(items, separator, itemsType)
Parameters:
| Name | Type | Description |
|---|---|---|
| items | number | string | array | 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 character. Possible values: ";", ",", "\", "/" 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:
boolean: 'true' if success, 'false' otherwise.