Page Schema Properties

A page within a survey that groups questions together.

Element type: page Key properties: 15

Generation Hints

• Aliases: form page, survey page, step.
• Use when: grouping questions into a page or step.
• Recommended properties: name, title, description, elements, visibleIf.

{ "name": "contact", "title": "Contact details", "elements": [] }

---

Usage Notes

• Pages group top-level form elements inside the root pages array.
• Use elements for questions and panels. Use Panel when grouping related fields inside a page.

Key Properties

name

• Type: string
• Default: —

A form element identifier.

title

• Type: text
• Default: —
• Localizable: Yes

A title for the form element. If title is undefined, the name property value is displayed instead.

description

• Type: text
• Default: —
• Localizable: Yes

Explanatory text displayed under the title.

elements

• Type: element[]
• Default: []
• Required: Usually yes

Questions and panels shown on this page. Each item must include a type and name unless it is a non-value display element.

visibleIf

• Type: condition
• Default: —

A Boolean expression. If it evaluates to false, this panel/page becomes hidden.

enableIf

• Type: condition
• Default: —

A Boolean expression. If it evaluates to false, this panel/page becomes read-only.

requiredIf

• Type: condition
• Default: —

A Boolean expression. If it evaluates to true, this panel/page becomes required (at least one question in the panel/page should have an answer).

readOnly

• Type: boolean
• Default: —

Makes the form element read-only.

navigationTitle

• Type: string
• Default: —
• Localizable: Yes

A caption displayed on a navigation button in the TOC or progress bar. Applies when showTOC is true or when the progress bar is visible, progressBarType is set to “pages”, and progressBarShowPageTitles is true.

navigationDescription

• Type: string
• Default: —
• Localizable: Yes

questionTitleLocation

• Type: string
• Default: "default"
• Allowed values: default, top, bottom, left, hidden

Sets a title location relative to the input field for questions that belong to this panel/page.

questionErrorLocation

• Type: string
• Default: "default"
• Allowed values: default, top, bottom

Specifies the error message position for questions that belong to this page/panel.

questionOrder

• Type: string
• Default: "default"
• Allowed values: default, initial, random

Specifies the sort order of questions in the panel/page.

showNavigationButtons

• Type: boolean
• Default: —

Gets or sets the visibility of the Start, Next, Previous, and Complete navigation buttons on this page. Overrides the showNavigationButtons property specified on the survey-level.

timeLimit

• Type: number
• Default: 0

A time period that a respondent has to complete this page; measured in seconds. Applies only to quiz surveys.