C1TrueDBList

Extends ActiveXObject

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.

Type: string

Accessors: GetCell

ColumnCount

Number of columns in the table.

Type: number

Accessors: GetColumnCount

ColumnName

Caption of a column.

Getter Parameters:

Name Type Description
col number Zero-based index of the column.

Type: string

Accessors: GetColumnName

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
column number Zero-based index of a column

Type: string|boolean

Accessors: GetItemNameByIndex

RowCount

Number of rows in the table.

Type: number

Accessors: GetRowCount

SelectedColumnCount

Number of selected columns.

Type: number

Accessors: GetSelectedColumnCount

SelectedColumns

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

Getter Parameters:

Name Type Description
asArray boolean If set to true, function returns an array.
separator string Separator character.
Optional, Default: ;.

Type: array|string

Accessors: GetSelectedColumns

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

Text

Text of the currently focused cell.

Type: string

Accessors: GetText

Action Detail

DoAddSelection

Extends selection.

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

DoClearSelection() 

Returns:

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

DoClickItem

Clicks the specified cell

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

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 object. Calculated from the top-left corner. Default is a center. Floating point in the range (-2, 2) means percentage of the width (requires Rapise 6.5+, also requires native events mode in Web tests).
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 (requires Rapise 6.5+, also requires native events mode in Web tests).
Optional.

Returns:

boolean: 'true' if successful, 'false' otherwise

DoFullText

Read and return full text contents of the table

DoFullText() 

Returns:

string |
boolean: Full text of the table (may be very long!), 'false' otherwise

DoRemoveSelection

Removes selection from specified items.

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

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