FarPointGrid

This behavior pattern implements standard behavior for Grid control.

Extends SeSSimulatedObject

Behavior Pattern: FarPointGridBehavior

Property Summary

Property Description Getter Setter
Cell Text of the specified cell. GetCell SetCell
ColumnCount Number of columns in the grid. GetColumnCount SetColumnCount
ColumnName Caption of a column. GetColumnName SetColumnName
RowCount Number of rows in the grid. GetRowCount SetRowCount
SelectedCells Selected cells. GetSelectedCells SetSelectedCells
SelectedColumn Index of the selected column. GetSelectedColumn
SelectedColumnCount Number of selected columns. GetSelectedColumnCount
SelectedRow Index of the selected row. GetSelectedRow
SelectedRowCount Number of selected rows. GetSelectedRowCount
Text Text of the currently focused cell. GetText SetText

Action Summary

Action Description
DoClickCell Clicks the specified cell
DoFullText Returns text representation of the table.

Property Detail

Cell

Text of the specified cell.

Getter Parameters:

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

Type: string

Accessors: GetCell, SetCell

ColumnCount

Number of columns in the grid.

Type: number

Accessors: GetColumnCount, SetColumnCount

ColumnName

Caption of a column.

Getter Parameters:

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

Type: string

Accessors: GetColumnName, SetColumnName

RowCount

Number of rows in the grid.

Type: number

Accessors: GetRowCount, SetRowCount

SelectedCells

Selected cells.

Getter Parameters:

Name Type Description
asArray
rowcolSep
cellSep

Type: array|string

Accessors: GetSelectedCells, SetSelectedCells

SelectedColumn

Index of the selected column.

Type: number

Accessors: GetSelectedColumn

SelectedColumnCount

Number of selected columns.

Type: number

Accessors: GetSelectedColumnCount

SelectedRow

Index of the selected row.

Type: number

Accessors: GetSelectedRow

SelectedRowCount

Number of selected rows.

Type: number

Accessors: GetSelectedRowCount

Text

Text of the currently focused cell.

Type: string

Accessors: GetText, SetText

Action Detail

DoClickCell(rowIndex, columnIndex)

Clicks the specified cell

Parameters:

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

Returns:

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

DoFullText(fileName)

Returns text representation of the table.

Parameters:

Name Type Description
fileName string Name of a file that should hold text representation of the grid.
Optional.

Returns:

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