page

The Page interface represents a displayable page of a form. A page can be displayed to a user as a web page or can be included within a PDF document (see WebForm#generatePdf(PdfOptions)).

Individual pages can be accessed via the Pages interface.

page Functions

getAllControls page.getAllControls( ) Returns an array of all controls on the page in display order.
clearFocus page.clearFocus( ) Removes any focus set on the page for individual controls using method Control#requestFocus().
getControlsByModifier page.getControlsByModifier( modifier ) Returns an array of controls that have the named modifier.
getNextPage page.getNextPage( ) Returns the Page object for the next page or null if no next page exists.
getPageControl page.getPageControl( ) Returns the Page Control that acts as the root control for all controls on the page.
getPreviousPage page.getPreviousPage( ) Returns the Page object for the previous page displayed to the user.

Element Functions

getElementName page.getElementName( ) Returns the element name
getElementType page.getElementType( ) Returns the element type

MessageContainer Functions

addErrorMessage page.addErrorMessage( message [, stopProcessing ] ) Adds an error message that will be displayed to the user.
addErrorMessage page.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) Adds an error message that will be displayed to the user.
addErrorMessageText page.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] ) Adds an error message that will be displayed to the user, sourced from an existing text.
addInfoMessage page.addInfoMessage( message [, stopProcessing ] ) Adds an information message that will be displayed to the user.
addInfoMessageText page.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] ) Adds an info message that will be displayed to the user, sourced from an existing text.
addWarningMessage page.addWarningMessage( message [, stopProcessing ] ) Adds a warning message that will be displayed to the user.
addWarningMessage page.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] ) Adds a warning message that will be displayed to the user.
addWarningMessageText page.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] ) Adds a warning message that will be displayed to the user, sourced from an existing text.
existErrorMessages page.existErrorMessages( ) Returns true if undisplayed error messages exist for this element, otherwise returns false.
existInfoMessages page.existInfoMessages( ) Returns true if undisplayed info messages exist for this element, otherwise returns false.
existMessages page.existMessages( ) Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false.
existWarningMessages page.existWarningMessages( ) Returns true if undisplayed warning messages exist for this element, otherwise returns false.