GetFormPage method (WinStudio scripts)

Applies To

IWSForm interface

Definition

Returns the index number of the currently active form page.

Syntax

object.GetFormPage( )


Part	Description
`object`	Required. The name of a valid form object.

Remarks

The return value is an integer indicating the index number of the currently active form page. The index is zero-based.

Note: Although it will work with any form, this method works most effectively with forms that have multiple pages, typically "wizard" forms.

Example

'Retrieve and display the index number for the active form page.
Sub Main
   Dim iActiveFormPage As Integer
   
   iActiveFormPage = Application.FindForm("formName").GetFormPage()
   Application.ShowMessage(CStr(iActiveFormPage))
End Sub