Skip to content

DomSAPGrid

Grid control.

Extends HTMLObject

Extends SeSSimulatedObject

Behavior Pattern: DomSAPGridBehavior

Property Summary

Property Description Getter Setter
Cell Text of the specified cell. GetCell
CellElement Get Cell element. GetCellElement
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

Action Summary

Action Description
DoClickCell Clicks the specified cell.
DoScrollTo Scrolls to the specified cell.
DoSelect Selects a dropdown item in the specified cell.
DoSelectAll Selects/deselects all rows based on check parameter value.
DoSelectRadio Select a radio button within a cell.
DoSelectRow Selects/deselects a given row based on check parameter value.
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

value = SeS('SomeDomSAPGrid').GetCell(/**number|string*/row, /**string|number*/col)

CellElement

Get Cell element.

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

Type: HTMLObject

Accessors: GetCellElement

value = SeS('SomeDomSAPGrid').GetCellElement(/**number|string*/row, /**string|number*/col)

ColumnCount

Number of columns in the grid.

Type: number

Accessors: GetColumnCount

value = SeS('SomeDomSAPGrid').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

value = SeS('SomeDomSAPGrid').GetColumnIndex(/**string*/columnName)

ColumnName

Caption of a column.

Getter Parameters:

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

Type: string

Accessors: GetColumnName

value = SeS('SomeDomSAPGrid').GetColumnName(/**number*/columnIndex)

RowCount

Number of rows in the grid.

Type: number

Accessors: GetRowCount

value = SeS('SomeDomSAPGrid').GetRowCount()

Action Detail

DoClickCell

Clicks the specified cell.

SeS('SomeDomSAPGrid').DoClickCell(row, col, clickType, xOffset, yOffset)

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 Possible values: "L", "LD", "R", "RD", "M", "MD", "N"
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

DoScrollTo

Scrolls to the specified cell.

SeS('SomeDomSAPGrid').DoScrollTo(row, col)

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

Selects a dropdown item in the specified cell.

SeS('SomeDomSAPGrid').DoSelect(row, col, item)

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

DoSelectAll

Selects/deselects all rows based on check parameter value.

SeS('SomeDomSAPGrid').DoSelectAll(check)

Parameters:

Name Type Description
check boolean Desired checkbox state.

Returns:

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

DoSelectRadio

Select a radio button within a cell.

SeS('SomeDomSAPGrid').DoSelectRadio(row, col, item)

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 Radio button caption.

Returns:

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

DoSelectRow

Selects/deselects a given row based on check parameter value.

SeS('SomeDomSAPGrid').DoSelectRow(row, check)

Parameters:

Name Type Description
row number Zero-based index if the row.
check boolean Desired checkbox state.

Returns:

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

DoSetText

Sets a text value into the specified cell.

SeS('SomeDomSAPGrid').DoSetText(row, col, text)

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