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.
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

CheckedCount

Returns number of checked items in ListView.

Type: number

Accessors: 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.
Optional, Default: ;.

Type: string

Accessors: GetCheckedIndices

ItemCount

Number of items.

Type: number

Accessors: 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

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

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.
Optional, Default: ;.

Type: string

Accessors: GetSelectedIndices

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.
Optional, Default: ;.

Type: string

Accessors: GetSelectedItems

SelectionCount

Number of selected items.

Type: number

Accessors: GetSelectionCount

Action Detail

DoAddSelection(items, separator, itemsType)

Extends selection.

Parameters:

Name Type Description
items number | string array
separator string Separator character.
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(items, separator, itemsType)

Checks items of this object.

Parameters:

Name Type Description
items number | string array
separator string Separator character.
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.

Returns:

boolean: 'true' if success, 'false' otherwise.

DoRemoveSelection(items, separator, itemsType)

Removes selection from specified items.

Parameters:

Name Type Description
items number | string array
separator string Separator character.
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(items, separator, itemsType)

Selects items of this object. First it clears existing selection.

Parameters:

Name Type Description
items number | string array
separator string Separator character.
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(bcheck, items, separator, itemsType)

Sets 'checked' state of the specified node.

Parameters:

Name Type Description
bcheck boolean Desired check state for the button.
items number | string array
separator string Separator character.
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.