VP Get sheet index
VP Get sheet index ( vpAreaName : Text ; name : Text ) : Integer
| Parameter | Type | Description | |
|---|---|---|---|
| vpAreaName | Text | -> | 4D View Pro area form object name |
| name | Text | -> | Sheet name |
| Function result | Integer | <- | Sheet index |
Description
The VP Get sheet index command returns the index of a sheet based on its name in vpAreaName.
In vpAreaName, pass the name of the 4D View Pro area.
In name, pass the name of the sheet whose index will be returned. If no sheet named name is found in the document, the method returns -1.
Indexing starts at 0.
Example
In the following document:
Get the index of the sheet called "Total first quarter":
$index:=VP Get sheet index("ViewProArea";"Total first quarter") //returns 2