VSFlexGrid¶

This behavior pattern implements standard behavior for Grid control.

Behavior Pattern: VSFlexGridBehavior

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
Height	Height of the object.	GetHeight
RowCount	Number of rows in the grid.	GetRowCount	SetRowCount
SelectedRow	Checked state of the selected node or a node specified by the input parameters.	GetSelectedRow	SetSelectedRow
SelectedRowCount	Number of selected rows.	GetSelectedRowCount
SelectedRows	Selected rows.	GetSelectedRows	SetSelectedRows
Text	Text of the currently focused cell.	GetText	SetText
Width	Width of the object.	GetWidth
X	X-coordinate of the top left corner of the object.	GetX
Y	Y-coordinate of the top left corner of the object.	GetY

Action Summary¶

Action	Description
DoClickCell	Clicks the specified cell.
DoClickText	Clicks on a specific text inside the grid.
DoFullText	Returns text representation of the grid.

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

Height¶

Height of the object.

Type: number

Accessors: GetHeight

RowCount¶

Number of rows in the grid.

Type: number

Accessors: GetRowCount, SetRowCount

SelectedRow¶

Checked state of the selected node or a node specified by the input parameters.

Type: boolean

Accessors: GetSelectedRow, SetSelectedRow

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. Possible values: ";", ",", "\", "/" Optional, Default: ";".

Type: array|string

Accessors: GetSelectedRows, SetSelectedRows

Text¶

Text of the currently focused cell.

Type: string

Accessors: GetText, SetText

Width¶

Width of the object.

Type: number

Accessors: GetWidth

X¶

X-coordinate of the top left corner of the object.

Type: number

Accessors: GetX

Y¶

Y-coordinate of the top left corner of the object.

Type: number

Accessors: GetY

Action Detail¶

DoClickCell¶

Clicks the specified cell.

DoClickCell(row, col, clickType)

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

Returns:

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

DoClickText¶

Clicks on a specific text inside the grid.

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¶

Returns text representation of the grid.

DoFullText(path, fmt)

Parameters:

Name	Type	Description
path	string	Name of a file that should hold text representation of the grid. Optional.
fmt	number	function () {
} Optional.

Returns:

string: Path to a file with grid text when 'path' param is defined. Otherwise return Grid text.