Toggle menu

Page Settings

Page settings control how an individual page behaves. They include the page name and title, whether or not the page repeats, and any handlers to load with the page.

There's more information about form and page initialisation handlers and the order they are executed in in the Form Functions, Handlers and Signatures article.

PropertyDescriptionType Name
TitleThe title of the page. This is output in read-only renderings of the form and will also be output in the headings of articles using the Forms Service template if you use the "Forms Service title format" tokens in your Subsite Configuration - Framework FeaturesTITLE
Server Init HandlerA JavaScript function executed server-side as the page loads. See Form Functions, Handlers and Signatures for a full explanation of the order in which the various handlers and functions are executedPAGEINITHANDLERSERVER
Client Init HandlerA JavaScript function executed client-side once the page has rendered. See Form Functions, Handlers and Signatures for a full explanation of the order in which the various handlers and functions are executed.

It is useful for showing/hiding fields on this page, for example:

function (helper, pageName, pageInstance) {
    helper.hideField("HELP");
}
PAGEINITHANDLER
RepeatableWhether or not this page should repeat, letting a user generate multiple instances of the page. The minimum and maximum number are set below. See Repeating Pages for the full documentationREPEATABLE
Validate Instance CountWhether or not to validate the number of instances generated. If true the wizard, navigation and submit button fields will check the current count of instances against the minimum and maximum set below. If false a user will be able to add as many or as few instances as they like (up to a maximum of 100).

If both the minimum and maximum are set as 0, and the count is being validated, the page will be skipped
VALIDATEPAGEINSTANCECOUNT
Minimum InstancesThe minimum number of instances that should be generated if Validate Instance Count is true.

The value of another field can be used by adding the field's name between # characters. The value of a variable can be used by adding the variable's name between % characters
MININSTANCES
Maximum InstancesThe maximum number of instances that should be generated if Validate Instance Count is true. Note that the Wizard Buttons - Repeating Pages field will hide the "Add another" button once the maximum number of instances has been reached.

The value of another field can be used by adding the field's name between # characters. The value of a variable can be used by adding the variable's name between % characters
MAXINSTANCES
Error MessageDisplayed when Validate Instance Count is true and the count of instances doesn't meet the minimum or maximum set above.

Default: You must provide #PAGEINSTANCEMIN# to #PAGEINSTANCEMAX# sets of data

The following tokens can be used:
  • #PAGEINSTANCE# - The current page instance (zero-based, ie the first instance is 0)
  • #PAGEINSTANCEDISPLAY# - The user friendly current page instance (one-based, ie the first instance is 1)
  • #PAGEINSTANCEMIN# - The minimum number of instances to generate (set in the forms designer)
  • #PAGEINSTANCEMAX# -The maximum number of instances to generate (set in the forms designer)
  • #PAGEINSTANCECOUNT# - The current number of instances (of this page) that have been generated
INSTANCECOUNTERRORMESSAGE
DocumentationAdd documentation to your page to help explain any complex functionality to future users. Notes added here are only ever visible in the Forms Designer, they can be searched for, viewed and downloaded from the action panel. There's an example in the Common Field Properties sectionDOCUMENTATION
Last modified on 30 January 2024

Share this page

Facebook icon Twitter icon email icon

Print

print icon