Returns information about a repeating page.
Defaults to the current page if a page name isn't set.
Executed
Client-side and server-side.
Arguments
| Argument | Type | Description |
|---|---|---|
| pageName | String, optional | The name of the repeating page to return information about. Defaults to the page the function is used on if not set |
Returns
Returns null for non-repeating pages.
Object. Information about the repeating page.
{
"canNavigateBackwards": true,
"canNavigateForwards": false,
"pageInstanceCount": 2,
"isPageInstanceCountValidated": true,
"canAddMoreInstances": true,
"canRemoveInstances": true,
"willSkipNavigation": false,
"willAddMoreInstances": false
}
| Property | Type | Description |
|---|---|---|
| canNavigateBackwards | Boolean | Will be true if there is a page instance you can navigate back to |
| canNavigateForwards | Boolean | Will be true if there are instances after the current instance (eg the user has navigated backwards through the instances) |
| pageInstanceCount | Integer | The count of instances |
| isPageInstanceCountValidated | Boolean | Whether or not the number of instances should be validated |
| canAddMoreInstances | Boolean | Will be true if the current count is less than the maximum instance count (set in the forms designer) or less than 100 (the platform-wide maximum) |
| canRemoveInstances | Boolean | Will be true if the current count is greater than the minimum instance count (set in the forms designer) or zero |
| willSkipNavigation | Boolean | Will be true if both the minimum and maximum instances are set as zero and the count is being validated. The page will be skipped |
| willAddMoreInstances | Boolean | Will be true if both the minimum and maximum instances are the same and the count is being validated. New instances will be automatically generated until the requited number is met |
Last modified on 16 November 2023
Share this page
