VP Get frozen panes

Home

4D v19

VP Get frozen panes


VP Get frozen panes ( vpAreaName {; sheet} ) -> Function result

Parameter	Type	Description
vpAreaName	Text	4D View Pro area form object name
sheet	Longint	Sheet index (current sheet if omitted)
Function result	Object	Object containing frozen column and row information

Description

The VP Get frozen panes command returns an object with information about the frozen columns and rows in vpAreaName.

In vpAreaName, pass the name of the 4D View Pro area. If you pass a name that does not exist, an error is returned.

In the optional sheet parameter, you can designate a specific spreadsheet where the range will be defined (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	Type	Value	Comment
vk current sheet	Longint	-1	Designates current sheet of the 4D View Pro area (default)

Returned object

The command returns an object describing the frozen columns and rows. This object can contain the following properties:

Property	Type	Description
columnCount	Longint	The number of frozen columns on the left of the sheet
trailingColumnCount	Longint	The number of frozen columns on the right of the sheet
rowCount	Longint	The number of frozen rows on the top of the sheet
trailingRowCount	Longint	The number of frozen rows on the bottom of the sheet

Example

You want to retrieve information about the number of frozen columns and rows:

 C_OBJECT($panesObj)

 

 $panesObj:=VP Get frozen panes("ViewProArea")

The returned object contains, for example: