ManagedListView¶
Managed ListView.
UI element class: System.Windows.Forms.ListView
Extends ManagedObject
Extends SeSSimulatedObject
Behavior Pattern: ManagedObjectListViewSelectableBehavior
Property Summary¶
| Property | Description | Getter | Setter |
|---|---|---|---|
| CheckBoxes | Returns true if items have checkboxes near them. | GetCheckBoxes | |
| CheckedCount | Returns number of checked items in ListView. | GetCheckedCount | |
| CheckedIndices | Returns string of indexes delimited by separator or array of indexes of selected elements. | GetCheckedIndices | |
| ItemCount | Number of items. | GetItemCount | |
| ItemIndexByName | Returns item index by its name. | GetItemIndexByName | |
| ItemNameByIndex | Returns item name by its index. | GetItemNameByIndex | |
| 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 | |
| SelectionCount | Number of selected items. | GetSelectionCount |
Action Summary¶
| Action | Description |
|---|---|
| DoAddSelection | Extends selection. |
| DoCheckItem | Checks items of this object. |
| DoClearSelection | Clears selection. |
| DoClickItem | Clicks the specified item |
| DoRemoveSelection | Removes selection from specified items. |
| DoSelectItem | Selects items of this object. |
| DoSetCheck | Sets 'checked' state of the specified node. |
Property Detail¶
CheckBoxes¶
Returns true if items have checkboxes near them.
Type: boolean
Accessors: GetCheckBoxes
value = SeS('SomeManagedListView').GetCheckBoxes()
CheckedCount¶
Returns number of checked items in ListView.
Type: number
Accessors: GetCheckedCount
value = SeS('SomeManagedListView').GetCheckedCount()
CheckedIndices¶
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: GetCheckedIndices
value = SeS('SomeManagedListView').GetCheckedIndices(asArray, separator)
ItemCount¶
Number of items.
Type: number
Accessors: GetItemCount
value = SeS('SomeManagedListView').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('SomeManagedListView').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('SomeManagedListView').GetItemNameByIndex(index)
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('SomeManagedListView').GetSelectedIndices(asArray, separator)
SelectedItems¶
Text of all the selected items in a single string. Items are divided by ';' separator.
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: GetSelectedItems
value = SeS('SomeManagedListView').GetSelectedItems(asArray, separator)
SelectionCount¶
Number of selected items.
Type: number
Accessors: GetSelectionCount
value = SeS('SomeManagedListView').GetSelectionCount()
Action Detail¶
DoAddSelection¶
Extends selection.
SeS('SomeManagedListView').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.
DoCheckItem¶
Checks items of this object.
SeS('SomeManagedListView').DoCheckItem(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('SomeManagedListView').DoClearSelection()
Returns:
boolean: 'true' if success, 'false' otherwise.
DoClickItem¶
Clicks the specified item
SeS('SomeManagedListView').DoClickItem(nameCaptionIndex, clickType, nSkipFirst, xOffset, yOffset)
Parameters:
| Name | Type | Description |
|---|---|---|
| nameCaptionIndex | string | number | index, name or caption of the item. |
| clickType | string | Type of click, can be one of "L" - left click, "LD" - double left click, "R" - right click, "RD" - double right click, "M" - middle click, "MD" - double middle click, "N" - don't click Possible values: "L", "LD", "R", "RD", "M", "MD", "N" Optional, Default: "L". |
| nSkipFirst | number | Index in the array if item is searched by name or regexp the text found several times. Optional. |
| xOffset | number | X offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the width. Optional. |
| yOffset | number | Y offset to click within object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the height. Optional. |
Returns:
boolean: 'true' if successful, 'false' otherwise
DoRemoveSelection¶
Removes selection from specified items.
SeS('SomeManagedListView').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('SomeManagedListView').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.
DoSetCheck¶
Sets 'checked' state of the specified node.
SeS('SomeManagedListView').DoSetCheck(bcheck, items, separator, itemsType)
Parameters:
| Name | Type | Description |
|---|---|---|
| bcheck | boolean | Desired check state for the button. |
| 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.