FarPointGrid¶

This behavior pattern implements standard behavior for Grid control.

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

value = SeS('SomeFarPointGrid').GetCell(/**number*/rowIndex, /**number*/columnIndex)

SeS('SomeFarPointGrid').SetCell(/**number*/rowIndex, /**number*/columnIndex, /**string*/value)

ColumnCount¶

Number of columns in the grid.

Type: number

Accessors: GetColumnCount, SetColumnCount

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

SeS('SomeFarPointGrid').SetColumnCount(/**number*/value)

ColumnName¶

Caption of a column.

Getter Parameters:

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

Type: string

Accessors: GetColumnName, SetColumnName

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

SeS('SomeFarPointGrid').SetColumnName(/**number*/columnIndex, /**string*/value)

RowCount¶

Number of rows in the grid.

Type: number

Accessors: GetRowCount, SetRowCount

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

SeS('SomeFarPointGrid').SetRowCount(/**number*/value)

SelectedCells¶

Selected cells.

Getter Parameters:

Name	Type	Description
asArray
rowcolSep
cellSep

Type: array|string

Accessors: GetSelectedCells, SetSelectedCells

value = SeS('SomeFarPointGrid').GetSelectedCells(/**boolean*/asArray, /**string*/rowcolSep, /**string*/cellSep)

SeS('SomeFarPointGrid').SetSelectedCells(/**number*/top, /**number*/left, /**number*/bottom, /**number*/right)

SelectedColumn¶

Index of the selected column.

Type: number

Accessors: GetSelectedColumn

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

SelectedColumnCount¶

Number of selected columns.

Type: number

Accessors: GetSelectedColumnCount

value = SeS('SomeFarPointGrid').GetSelectedColumnCount()

SelectedRow¶

Index of the selected row.

Type: number

Accessors: GetSelectedRow

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

SelectedRowCount¶

Number of selected rows.

Type: number

Accessors: GetSelectedRowCount

value = SeS('SomeFarPointGrid').GetSelectedRowCount()

Text¶

Text of the currently focused cell.

Type: string

Accessors: GetText, SetText

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

SeS('SomeFarPointGrid').SetText(/**string*/value)

Action Detail¶

DoClickCell¶

Clicks the specified cell

SeS('SomeFarPointGrid').DoClickCell(rowIndex, columnIndex)

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¶

Returns text representation of the table.

SeS('SomeFarPointGrid').DoFullText(fileName)

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.