Question Properties
Question level properties let you format Question settings such as:
- Nesting
- Formatting
- Question notes
- Annotation placement
Prefill Value
Lets you enter a value to pre-fill the Question display. Note: The Question mark character ('?') is interpreted as a blank space. All other characters are displayed in the Question display.
Nesting Parent OID
Specifies the OID of the parent Question inside which the current Question should be nested.
Nesting Parent Choice
Specifies which Code List coded value the Question should be nested inside. This property should not be specified if the ‘Display’ property at Section level is set to 'Code List - Footnote'.
Nesting Placement
Specifies the positioning of a Nested Question positioning. This property should be used on the parent Question:
- 'Beside' the first nested Question is created beside the parent Item
- 'Below' the first nested Question is created below the parent Item.
If left blank, this property defaults to 'Below'.
Nesting Orientation
Specifies the orientation of nested Items:
- 'Horizontal' displays nested Question next to each other
- 'Vertical' displays nested Question below each other.
This property should be used on the parent Question. If left blank, this property defaults to 'Vertical'.
Control Placement
Specifies the placement of the Question control if the ‘Show Question’ property is set to 'true'.
- 'Beside' displays the control beside the question text
- If 'Below' displays the control below the question text
If left blank, this property defaults to 'Beside'.
Display
- ‘None’ hides the Question display but retains the space allocated for the display. This is the default setting if the Question data type is ‘text’, the ‘Table Visible’ property is set to ‘true’ and there are no child Questions.
- ‘Lines’
- ‘Box’
- ‘Delineated (Semi-closed)’
- ‘Delineated (Closed)’
- ‘Delineated (Open)’
- ‘CodeList – Radio Button (Vertical)’
- ‘CodeList – Radio Button (Horizontal)’
- ‘CodeList – Footnote’
Note that if an Item is set as a ‘CodeList - Footnote’ and it is the parent of another Item, $Display will act as though both ‘Box’ and ‘CodeList - Footnote’ are selected. CodeList displays should only be used for Items that have a reference to a CodeList.
Check boxes are achieved by setting datatype: 'boolean' or attaching a CodeList with only one CodeList Item.
Notes Above
Lets you enter a list of notes to be displayed above the Question. This property should only be used when the 'Layout’ is set to 'Tabular (Vertical)' or 'Non Tabular (Vertical)'.
Notes Below
Lets you enter a list of notes to be displayed below the Question. This property should only be used when the 'Layout’ is set to 'Tabular (Vertical)' or 'Non Tabular (Vertical)'.
Show Question
Lets you show or hide the Question text. If left blank, this property defaults to 'true'.
Show Codes
Lets you show or hide Coded Values for a Question that has Terminologies attached:
- ‘true’ displays Coded Values
- ‘false’ hides Coded Values
If left blank, this property defaults to ‘true’ unless otherwise specified in the ‘Default Show Codes’ property. Note: If the ‘Display’ property is set to ‘CodeList – Footnote’ the Coded Values will be displayed.
Show Measurement Units
Lets you show or hide Measurement Units for a Question.
- 'true' displays Measurement Units
- 'false' hides Measurement Units
If left blank, this property defaults to 'true'.
Text Width (CM)
Specifies the width of the Question display (in centimeters) when the ‘Display’ property is set to 'Box', 'Lines' or 'None'. Minimum Value is '0'. If left blank, this property defaults to '3'.
Text Height Lines
Specifies the Question display height (in number of lines) when the ‘Display’ property is set to 'Box', 'Lines' or 'None'. If left blank, this property defaults to '1'.
Space Before (CM)
Specifies the indentation space (in centimeters) to the left of a nested Question. Minimum value is '0'. If left blank, this property defaults to '1'.
Grouping Item
Specifies the formats to be used if the selected Question is used to group a set of nested Questions (for example, a group of checkboxes).
- 'true' shows the display for the Question
- 'false' hides the display for the Question
If left blank, this property defaults to 'false'.
Date Time Positioning
Specifies the positioning of the date and time displays.
- 'Side-by-side' shows the date and time displays next to each other
- 'Separate Lines' shows the date and time displays on separate lines
This property should only be used for Questions where the DataType is 'datetime', 'partialDateTime' or 'incompleteDateTime'.
If left blank, this property defaults to 'Separate Lines'.
Notes
Lets you enter notes to be displayed with the Question text.
Notes After
Lets you enter notes to be displayed to the right of the Question display.
Font Family
Specifies the font size for the Question. If left blank, this property defaults to 'san serif' unless otherwise specified at asset group level, Form level or Section level.
Font Size
Specifies the font size for the Question. Measurement units are point (‘pt’), pixels (‘px’) or ‘em’. For example, ‘20px’. If left blank, this property defaults to '11pt' unless otherwise specified at asset group level, Form level or Section level.
Date Entry Format
Specifies the date entry format for a Question. This property may be used when the DataType is ‘date’, ‘datetime’, ‘partialDate’, ‘partialDateTime’ or ‘incompleteDateTime'. If left blank, this property defaults to ‘DDMMMYYYY’ unless otherwise specified in the ‘Default Date Entry Format’ property
Time Entry Format
Specifies the time entry format for a Question. This property may be used when the DataType is ‘time’, ‘datetime’, ‘partialTime’, ‘partialDatetime’ or ‘incompleteDatetime’. If left blank, this property defaults to ’24-hour’ unless otherwise specified in the ‘Default Time Entry Format’ property.
Radio Button Style
Formats the default radio button style for all Questions that display a radio button. If left blank, this property defaults to ‘Round’.
Control Border
Formats the default control borders when the ‘Display’ property is set to ‘Box’. For each border you can configure the following parts:
- Control border width (for example, ‘2pt’)
- Border style (for example, ‘dashed’)
- Border color (for example, ‘black’)
Each part must be separated by a semi-colon (‘;’)
Each part can contain 4 values. The first, second, third and fourth values in each part are applied to the border sides in the following order:
- Top
- Right
- Bottom
- Left
For example, ‘1pt 2pt 3pt 4pt; solid dashed groove ridge; blue black yellow red If only one value is specified for each part, this value will be applied to all border sides. If left blank, this property defaults to ‘1pt; solid; black'. This property can be overridden at individual Question level using the ‘Control Border’ property.
Notes Below Control
Lets you enter a list of notes to be displayed below the Question Control.
Measurement Unit Orientation
Specifies the orientation of the listed Measurement Units for the Question. This setting is only relevant if the Question has more than 1 possible measurement unit. If left blank, this property defaults to Vertical.
Show Item
Lets you show or hide a Question on the relevant Form. If left blank, this property defaults to ‘true’.
Item Annotation
Specifies the width, height, horizontal offset and vertical offset for the Question annotation. Measurement units are inches (‘in’) or centimeters (‘cm’). For example, ‘1cm’.
Code List Annotation
Specifies the width, height, horizontal offset and vertical offset for the Code List annotation. Measurement units are inches (‘in’) or centimeters (‘cm’). For example, ‘1cm’.
Measurement Unit Annotation
Specifies the width, height, horizontal offset and vertical offset for the Measurement Unit annotation. Measurement units are inches (‘in’) or centimeters (‘cm’). For example, ‘1cm’.