DXCheckedListBoxControl¶
DevXpress CheckedListBoxControl.
UI element class: regex:DevExpress.XtraEditors.CheckedListBoxControl|DevExpress.XtraEditors.Popup.PopupCheckedListBoxControl
Extends ManagedObject
Extends SeSSimulatedObject
Behavior Pattern: DXCheckedListBoxControlBehavior
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.
Type: number
Accessors: GetCheckedCount
value = SeS('SomeDXCheckedListBoxControl').GetCheckedCount()
CheckedIndices¶
Array of indices of checked 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: array|string
Accessors: GetCheckedIndices
value = SeS('SomeDXCheckedListBoxControl').GetCheckedIndices(asArray, separator)
CheckedItems¶
Array of item names of checked 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: array|string
Accessors: GetCheckedItems
value = SeS('SomeDXCheckedListBoxControl').GetCheckedItems(asArray, separator)
ItemCount¶
Number of items.
Type: number
Accessors: GetItemCount
value = SeS('SomeDXCheckedListBoxControl').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('SomeDXCheckedListBoxControl').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('SomeDXCheckedListBoxControl').GetItemNameByIndex(index)
SelectedIndex¶
Index of the selected element of the object.
Type: number
Accessors: GetSelectedIndex, SetSelectedIndex
value = SeS('SomeDXCheckedListBoxControl').GetSelectedIndex()
SeS('SomeDXCheckedListBoxControl').SetSelectedIndex(value)
SelectedIndices¶
Returns string of indexes delimited by separator or array of indexes of selected elements.
Type: string
Accessors: GetSelectedIndices
value = SeS('SomeDXCheckedListBoxControl').GetSelectedIndices()
SelectedItems¶
Text of all the selected items in a single string. Items are divided by ';' separator.
Type: string
Accessors: GetSelectedItems
value = SeS('SomeDXCheckedListBoxControl').GetSelectedItems()
SelectedText¶
Text of the selected item in a single string.
Type: string
Accessors: GetSelectedText
value = SeS('SomeDXCheckedListBoxControl').GetSelectedText()
SelectionCount¶
Number of selected items.
Type: number
Accessors: GetSelectionCount
value = SeS('SomeDXCheckedListBoxControl').GetSelectionCount()
Action Detail¶
DoAddSelection¶
Extends selection.
SeS('SomeDXCheckedListBoxControl').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('SomeDXCheckedListBoxControl').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('SomeDXCheckedListBoxControl').DoClearSelection()
Returns:
boolean: 'true' if success, 'false' otherwise.
DoRemoveSelection¶
Removes selection from specified items.
SeS('SomeDXCheckedListBoxControl').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('SomeDXCheckedListBoxControl').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('SomeDXCheckedListBoxControl').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.