5.4.6 GET
The GET command is used to get information about the current open document.
Syntax:
|
Command
|
Keyword
|
Value
|
Developer notes
|
|
GET
|
OBJECT
|
*SHEETS
|
Returns a working list with all the sheet names in the current document. Use the optional keyword QUOTE(*YES) to have the sheet name double quoted.
|
|
*NAMES
|
Returns a working list with all the defined names in the current document. If the working list has two fields then the second field receives the define name reference formula.
|
|
*ROWCOUNT
|
Returns the number of rows in the worksheet specified by the SHEET keyword into the #JSMMSG field.
|
|
*COLUMNCOUNT
|
Returns the maximum number of columns in the worksheet specified by the SHEET keyword into the #JSMMSG field.
|
|
*CELLCOUNT
|
Returns the number of cells in the worksheet specified by the SHEET keyword and the row specified by the ROW keyword into the #JSMMSG field.
|
|
*CELL
|
Returns the cell value into the #JSMMSG response field. Refer to keywords R1C1, NAME, SCALE and NUMBERFORMAT.
|
|
SHEET
|
value
|
A specific sheet name can be entered otherwise the current context sheet is used.
|
|
R1C1
|
value
|
Cell row and column. This keyword can be used instead of NAME.
|
|
NAME
|
value
|
Defined name. The defined name contains the cell location in standard Excel A1 reference style. For example. C10 or SheetName!C10.
|
|
SCALE
|
value
|
This optional keyword specifies the decimal scale that will be used on numeric cells that have a general number format.
The default value is 4.
|
|
NUMBERFORMAT
|
|
Optional. See NUMBERFORMAT.
|
|
Example
GET OBJECT(*NAMES) #WRLST(NAME)
GET OBJECT(*SHEETS) #WRLST(NAME)
GET OBJECT(*SHEETS) QUOTE(*YES) #WRLST(NAME)
GET OBJECT(*ROWCOUNT)
GET OBJECT(*ROWCOUNT) SHEET(Sales)
GET OBJECT(*COLUMNCOUNT)
GET OBJECT(*COLUMNCOUNT) SHEET(Sales)
GET OBJECT(*CELLCOUNT) ROW(2)
GET OBJECT(*CELLCOUNT) ROW(2) SHEET(Sales)
GET OBJECT(*CELL) NAME(C10)
GET OBJECT(*CELL) R1C1(5,10) SHEET(Sales)
GET OBJECT(*CELL) R1C1(5,10) SCALE(2)
