VP Get sheet options
VP Get sheet options ( vpAreaName : Text {; sheet : Integer } ) ) : Object
| Parameter | Type | Description | |
|---|---|---|---|
| vpAreaName | Text | -> | 4D View Pro area from object name |
| sheet | Integer | -> | Sheet index (current sheet if omitted) |
| Result | Object | <- | Sheet options object |
Description
The VP Get sheet options command returns an object containing the current sheet options of the vpAreaName area.
Pass the name of the 4D View Pro area in vpAreaName. If you pass a name that does not exist, an error is returned.
In the optional sheet parameter, you can designate a specific spreadsheet (counting begins at 0). If omitted or if you pass vk current sheet, the current spreadsheet is used.
Returned object
The method returns an object containing the current values for all available sheet options. An option value may have been modified by the user or by the VP SET SHEET OPTIONS method.
To view the full list of the options, see Sheet Options.
Example
$options:=VP Get sheet options("ViewProArea")
If($options.colHeaderVisible) //column headers are visible
... //do something
End if