GetSelRange Function (Table)

Class

Table.

Action

Returns the selected range in a table.

Availability

This functionality is supported only if you are using the Classic Agent.

Syntax

trSelection = table.GetSelRange ([bAsText])
Variable Description
trSelection The selected range. TABLERANGE.
bAsText Optional: If TRUE, trSelection is the string form of TABLEROW and TABLECOL; if FALSE, trSelection is the integer form. Default is TRUE. BOOLEAN.

Notes

GetSelRange returns a TABLERANGE that is formatted according to the value of bAsText. If you want the cell in string format, specify TRUE for bAsText and the returned cells will take the form shown in the following example:
{"2", "id"}
If you want the cell in integer format, specify FALSE for bAsText and the returned cells will take the form shown in the following example:
{2, 1}
If multiple disconnected ranges are selected, the method returns the first selected range.

Example

TABLERANGE trRange
trRange = Emp.EmpTable.GetSelRange()
// Returns:
// {{"2", "id"}, {"2", "ship_date"}}