Page

Interface to a page

Members

(readonly) application :Application

The application.

Type:
Since

(readonly) hasBack :Boolean

Whether or not the page supports back navigation. This is useful for implementing custom prompt controls.

Type:
  • Boolean
Example

Disable a custom back button if back navigation is not possible

btnCustomBackButton.disabled = !oPage.hasBack;

(readonly) name :String

The page name.

Type:
  • String

(async, readonly) pageModuleInstance :Promise

The PageModule instance. Since modules are loaded asynchronously, the instance may not be immediately available.

Type:
Example

Obtain a reference to a page module instance.

const oModuleInstance = await oPage.pageModuleInstance;
// The module instance is available here

Methods

getAllPromptControls() → {Array.<PromptControl>}

Get all prompt controls.

Since
Returns:

All prompt controls on the page. If no prompt controls are found, an empty array is returned.

Type: 
Array.<PromptControl>
Example
const aControls = oPage.getAllPromptControls();

getControlByName(sName) → (nullable) {Control}

Get a control by name.

Parameters:
NameTypeDescription
sNameString

The name of the control.

Returns:

The first control found with that name on the page. If no control is found, null is returned.

Type: 
Control
Example
const oControl = oPage.getControlByName( "SelectValue1" );

getControlsByName(sName) → {Array.<Control>}

Get all controls with a name.

Parameters:
NameTypeDescription
sNameString

The name of the control.

Returns:

All controls on the page with the name. If no controls are found, an empty array is returned.

Type: 
Array.<Control>
Example
const aControls = oPage.getControlsByName( "SelectValue1" );

getControlsByNodeName(…sNodeName) → {Array.<Control>}

Get controls by node name. Note: Only named specification nodes will be found.

Parameters:
NameTypeAttributesDescription
sNodeNameString<repeatable>

The node name of the control. Multiple node names can be passed as separate parameters.

Since
Returns:

All controls with the matching node name(s) on the page. If no controls are found, an empty array is returned.

Type: 
Array.<Control>
Examples
const aControls = oPage.getControlsByNodeName( "selectValue" );
const aControls = oPage.getControlsByNodeName( "list", "crosstab", "table" );