VP Get column count

Home

4D v19

VP Get column count


VP Get column count ( vpAreaName {; sheet} ) -> Function result

Parameter	Type	Description
vpAreaName	Text	4D View Pro area from object name
sheet	Longint	Sheet index (current sheet if omitted)
Function result	Longint	Total number of columns

Description

The VP Get column count command returns the total number of columns from the designated sheet.

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

You can define where to get the column count in the optional sheet parameter using the sheet index (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)

Example

The following code returns the number of columns in the 4D View Pro area:

 C_LONGINT($colCount)

 $colCount:=VP Get column count("ViewProarea")