Manual > Control Reference > Basics > Grid control > Methods

Get data from cells in bulk.

Syntax 1

GetTableData(

&data,

areaType

)

Gets all the cell data in the specified area at once.

Parameters

&data
	Type:	General purpose
	Data is received in a two-dimensional array (table) consisting of columns and rows.

areaType

Type:

character

"all" - All cells (not including header cells).

"select" - The currently selected range of cells.

"cursor" - The cell where the cursor is currently located. If only one cell is selected, this is the same as "select".

"headerx" - Header cell (horizontal).

"headery" - Header cell (vertical).

"allandheader" - All cells including header cells.

"allandheaderx" - all cells including header cells (horizontally).

"allandheadery" - all cells including header cells (vertically).

Return Value


	Type:	Boolean
	FALSE - Failure. TRUE - Success.

Syntax 2

GetTableData(

&data,

"row",

displayRow

)

Gets the data for the specified row.

Parameters

&data
	Type:	General purpose
	Data is received in a two-dimensional array (table) consisting of columns and rows.

areaType
	Type:	character
	"row"

displayRow
	Type:	Number
	Display index of the row (row number starting from 0).

Return Value


	Type:	Boolean
	FALSE - Failure. TRUE - Success.

Syntax 3

GetTableData(

&data,

"col",

displayCol

)

Gets the data for the specified column.

Parameters

&data
	Type:	General purpose
	Data is received in a two-dimensional array (table) consisting of columns and rows.

areaType
	Type:	character
	"col"

displayCol
	Type:	Number
	ColumnDisplay index (column number starting from 0).

Return value


	Type:	Boolean
	FALSE - Failure. TRUE - Success.

Syntax 4

GetTableData(

&data,

"range",

displayCol1,

displayRow1,

displayCol2,

displayRow2

)

Gets the data of the cells in the specified range.

Parameters

&data
	Type:	General purpose
	Data is received in a two-dimensional array (table) consisting of columns and rows.

areaType
	Type:	character
	"range"

displayCol1
	Type:	Number
	Display index of column 1 (column number starting from 0).

displayRow1
	Type:	Number
	Display index of row 1 (row number starting from 0).

displayCol2
	Type:	Number
	Display index of column 2 (column number starting from 0).

displayRow2
	Type:	Number
	Display index of row 2 (row number starting from 0).

Return Value


	Type:	Boolean
	FALSE - Failure. TRUE - Success.

reference