ManagedCheckedListBox

Top  Previous  Next

 

Managed Checked ListBox. Extends ManagedObject. Extends SeSSimulatedObject.

 

Behavior Pattern: ManagedObjectCheckedListBoxSelectableBehavior

 

Property Summary

 

Property

Description

Getter

Setter

CheckedCount

Returns number of checked items in ListView.

GetCheckedCount


CheckedIndices

Array of indices of checked elements.

GetCheckedIndices


CheckedItems

Array of item names of checked elements.

GetCheckedItems


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.

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

 

CheckedCount

Returns number of checked items in ListView.

Accessors: GetCheckedCount

 

CheckedIndices

Array of indices of checked elements.

Accessors: GetCheckedIndices

 

CheckedItems

Array of item names of checked elements.

Accessors: GetCheckedItems

 

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.

 

DoCheckItem(items, separator, itemsType)

Checks items of this object.

 

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.

 

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

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.