This is the legacy 4D documentation web site. Documentations are progressively being moved to developer.4d.com

Home

 
4D v19
VP Get sheet options

VP Get sheet options 


 

VP Get sheet options ( vpAreaName {; sheet} ) -> Function result 
Parameter Type   Description
vpAreaName  String in 4D View Pro area name
sheet  Longint in Sheet index (current sheet if omitted)
Function result  Object in Sheet options object

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, the current spreadsheet is used by default. You can explicitly select the current spreadsheet with the following constant: 

Constant Value Comment
vk current sheet -1 Designates current sheet of the 4D View Pro area (default)

 

Returned object

The command 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 command.

To view the full list of the options, see 4D View Pro Sheet Options

Example  

 $options:=VP Get sheet options("ViewProArea")
 If($options.colHeaderVisible) //column headers are visible
    ... //do somethnig
 End if



See also 

4D View Pro Sheet Options
VP SET SHEET OPTIONS

 
PROPERTIES 

Product: 4D
Theme: 4D View Pro Language
Number: 9957

 
PAGE CONTENTS 
 
HISTORY 

Created: 4D v18 R3

 
ARTICLE USAGE

4D View Pro Reference ( 4D v19)