This page is maintained for older versions of Rapise only. The latest documentation can be found at: https://rapisedoc.inflectra.com
DomDynamicsNAVGrid

DomDynamicsNAVGrid

Top  Previous 

 

This behavior pattern implements standard behavior for Grid control. Extends HTMLObject. Extends SeSSimulatedObject.

 

Behavior Pattern: DomDynamicsNAVGridBehavior

 

Property Summary

 

Property

Description

Getter

Setter

Cell

Text of the specified cell.

GetCell


ColumnCount

Number of columns in the grid.

GetColumnCount


ColumnIndex

Index of a column with a given name.

GetColumnIndex


ColumnName

Caption of a column.

GetColumnName


RowCount

Number of rows in the grid.

GetRowCount


SelectedRow

Index of the selected row.

GetSelectedRow


SelectedRowCount

Number of selected rows.

GetSelectedRowCount


SelectedRows

Selected rows.

GetSelectedRows


 

Action Summary

 

Action

Description

DoClickCell

Clicks the specified cell.

DoFullText

Returns text representation of the table.

DoLookup

Opens lookup table for the specified cell.

DoSelect

Selects a dropdown item in the specified cell.

DoSetText

Sets a text value into the specified cell.

 

Property Detail

 

Cell

Text of the specified cell.

 

Getter Parameters:

 

Name

Type

Description

row

number |
string

Zero-based index of a row or cell text.

col

string |
number

Name of a column or zero-based column index.

 

Type: string

 

Accessors: GetCell

 

ColumnCount

Number of columns in the grid.

 

Type: number

 

Accessors: GetColumnCount

 

ColumnIndex

Index of a column with a given name.

 

Getter Parameters:

 

Name

Type

Description

columnName

string

Name of a column.

 

Type: string

 

Accessors: GetColumnIndex

 

ColumnName

Caption of a column.

 

Getter Parameters:

 

Name

Type

Description

columnIndex

number

Zero-based index of the column.

 

Type: string

 

Accessors: GetColumnName

 

RowCount

Number of rows in the grid.

 

Type: number

 

Accessors: GetRowCount

 

SelectedRow

Index of the selected row.

 

Type: number

 

Accessors: GetSelectedRow

 

SelectedRowCount

Number of selected rows.

 

Type: number

 

Accessors: GetSelectedRowCount

 

SelectedRows

Selected rows.

 

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

 

Action Detail

 

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

Clicks the specified cell.

 

Parameters:

 

Name

Type

Description

row

number |
string

Zero-based index if the row or text of a cell in the specified column.

col

string |
number

Zero-based index of the column or column name.

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:

 

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

 

DoFullText()

Returns text representation of the table.

 

Returns:

 

string |
boolean: Text representation of the grid, 'true' if the file was successfully written, 'false' otherwise.

 

DoLookup(row, col)

Opens lookup table for the specified cell.

 

Parameters:

 

Name

Type

Description

row

number |
string

Zero-based index if the row or text of a cell in the specified column.

col

string |
number

Zero-based index of the column or column name.

 

Returns:

 

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

 

DoSelect(row, col, item)

Selects a dropdown item in the specified cell.

 

Parameters:

 

Name

Type

Description

row

number |
string

Zero-based index if the row or text of a cell in the specified column.

col

string |
number

Zero-based index of the column or column name.

item

string

Text of an item in the dropdown.

 

Returns:

 

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

 

DoSetText(row, col, text)

Sets a text value into the specified cell.

 

Parameters:

 

Name

Type

Description

row

number |
string

Zero-based index if the row or text of a cell in the specified column.

col

string |
number

Zero-based index of the column or column name.

text

string

Text to set into the cell.

 

Returns:

 

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