Skip to main content
Version: 20 R6 BETA

VP Get sheet index

VP Get sheet index ( vpAreaName : Text ; name : Text ) : Integer

ParameterTypeDescription
vpAreaNameText->4D View Pro area form object name
nameText->Sheet name
Function resultInteger<-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

See also

VP Get sheet count
VP Get sheet name