C1TrueDBListCombo

Top  Previous  Next

 

Extends SeSSimulatedObject.

 

Behavior Pattern: C1TrueDBListBehavior

 

Property Summary

 

Property

Description

Getter

Setter

Cell

Text of the specified cell.

GetCell


ColumnCount

Number of columns in the table.

GetColumnCount


ColumnName

Caption of a column.

GetColumnName


ItemCount

Number of items.

GetItemCount


ItemIndexByName

Returns item index by its name.

GetItemIndexByName


ItemNameByIndex

Returns item name by its index.

GetItemNameByIndex


RowCount

Number of rows in the table.

GetRowCount


SelectedColumnCount

Number of selected columns.

GetSelectedColumnCount


SelectedColumns

Returns string of indexes delimited by separator or array of indexes of selected columns.

GetSelectedColumns


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


Text

Text of the currently focused cell.

GetText


 

Action Summary

 

Action

Description

DoAddSelection

Extends selection.

DoClearSelection

Clears selection.

DoClickItem

Clicks the specified cell

DoFullText

Read and return full text contents of the table

DoRemoveSelection

Removes selection from specified items.

DoSelectItem

Selects items of this object.

 

Property Detail

 

Cell

Text of the specified cell.

Accessors: GetCell

 

ColumnCount

Number of columns in the table.

Accessors: GetColumnCount

 

ColumnName

Caption of a column.

Accessors: GetColumnName

 

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

 

RowCount

Number of rows in the table.

Accessors: GetRowCount

 

SelectedColumnCount

Number of selected columns.

Accessors: GetSelectedColumnCount

 

SelectedColumns

Returns string of indexes delimited by separator or array of indexes of selected columns.

Accessors: GetSelectedColumns

 

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

 

SelectionCount

Number of selected items.

Accessors: GetSelectionCount

 

Text

Text of the currently focused cell.

Accessors: GetText

 

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.

 

DoClearSelection()

Clears selection.

 

Returns:

 

'true' if success, 'false' otherwise.

 

DoClickItem(row, col, clickType, xOffset, yOffset)

Clicks the specified cell

 

Parameters:

 

Name

Type

Description

row

number

Zero-based index if the row.

col

number

Zero-based index of the column.

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

xOffset

number

X offset to click within node. Default is a center.
Optional.

yOffset

number

Y offset to click within node. Default is a center.
Optional.

 

Returns:

 

'true' if successful, 'false' otherwise

 

DoFullText()

Read and return full text contents of the table

 

Returns:

 

Full text of the table (may be very long!), '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.

 

Behavior Pattern: C1TrueDBGridComboBehavior

 

Property Summary

 

Property

Description

Getter

Setter

SelectedIndex

Index of the selected element of the object.

GetSelectedIndex

SetSelectedIndex

SelectedItem

Returns the selected item

GetSelectedItem


Text

Returns the text of the selected item

GetText


 

Action Summary

 

Action

Description

DoSelectItem

Selects an item of this object.

 

Property Detail

 

SelectedIndex

Index of the selected element of the object.

Accessors: GetSelectedIndex, SetSelectedIndex

 

SelectedItem

Returns the selected item

Accessors: GetSelectedItem

 

Text

Returns the text of the selected item

Accessors: GetText

 

Action Detail

 

DoSelectItem(item)

Selects an item of this object.

 

Parameters:

 

Name

Type

Description

item

string |
number

Item index or text value to select.

 

Returns:

 

'true' if success, 'false' otherwise.