Skip to content

DXGridControl

DevXpress GridControl.

UI element class: DevExpress.XtraGrid.GridControl

Extends ManagedObject

Extends SeSSimulatedObject

Behavior Pattern: DXGridControlBehavior

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
RowCount Number of rows in the table. GetRowCount
SelectedColumn Index of the selected column. GetSelectedColumn
SelectedRow Index of the selected row. GetSelectedRow
Text Text of the currently focused cell. GetText

Action Summary

Action Description
DoClickCell Clicks the specified cell.
DoClickColumn Clicks on column header
DoClickText Clicks on a specific text inside the grid.
DoFullText Full text of the table (may be very long!).

Property Detail

Cell

Text of the specified cell.

Type: string

Accessors: GetCell

value = SeS('SomeDXGridControl').GetCell(/**number*/row, /**number*/col)

ColumnCount

Number of columns in the table.

Type: number

Accessors: GetColumnCount

value = SeS('SomeDXGridControl').GetColumnCount()

ColumnName

Caption of a column.

Getter Parameters:

Name Type Description
columnIndex number Zero-based index of the column.
defSep string Separator for multi-level columns.
Optional.

Type: string

Accessors: GetColumnName

value = SeS('SomeDXGridControl').GetColumnName(/**number*/columnIndex, /**string*/defSep)

RowCount

Number of rows in the table.

Type: number

Accessors: GetRowCount

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

SelectedColumn

Index of the selected column.

Type: number

Accessors: GetSelectedColumn

value = SeS('SomeDXGridControl').GetSelectedColumn()

SelectedRow

Index of the selected row.

Type: number

Accessors: GetSelectedRow

value = SeS('SomeDXGridControl').GetSelectedRow()

Text

Text of the currently focused cell.

Type: string

Accessors: GetText

value = SeS('SomeDXGridControl').GetText()

Action Detail

DoClickCell

Clicks the specified cell.

SeS('SomeDXGridControl').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

DoClickColumn

Clicks on column header

SeS('SomeDXGridControl').DoClickColumn(col, clickType, xOffset, yOffset)

Parameters:

Name Type Description
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 Possible values: "L", "LD", "R", "RD", "M", "MD", "N"
Optional, Default: "L".
xOffset number X offset to click within header. Default is a center.
Optional.
yOffset number Y offset to click within header. Default is a center.
Optional.

DoClickText

Clicks on a specific text inside the grid.

SeS('SomeDXGridControl').DoClickText(textOrRegexp, clickType)

Parameters:

Name Type Description
textOrRegexp string Text (or regex: expression) to search in the grid.
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".

Returns:

'true' if successful, 'false' otherwise

DoFullText

Full text of the table (may be very long!).

SeS('SomeDXGridControl').DoFullText()

Returns:

string: Table's full text