Control settings
Introduction
The Control Settings dialog allows controlling all the aspects the a control besides its label and hint. The dialog has several tabs, detailed below.
Basic Settings
Basic options
The control name specifies a identifier for the control, unique in the entire form (except Section Templates). The identifier is used for the following:
to refer to the control value from formulas
to determine the name when the form data is represented as XML
If no control name is explicitly specified, Form Builder assigns a default name, such as control-42.
The following options are available:
Show in Summary:
When selected, the control value is visible as a Summary page column.
Show in Search:
When selected, the control value is searchable in the Summary page.
Encrypt data at rest:
SINCE Orbeon Forms 2018.1
This is an Orbeon Forms PE feature.
TODO
Email Recipient:
When selected, the control is used to determine an email recipient ("To:") when the form data is sent by email.
If more than one non-blank email addresses is found, they are all included as email recipients. In addition, the
oxf.fr.email.toproperty is used.
Email Carbon Copy Recipient:
SINCE Orbeon Forms 2017.1
When selected, the control is used to determine a carbon copy email recipient ("Cc:") when the form data is sent by email.
If more than one non-blank email addresses is found, they are all included as email recipients. In addition, the
oxf.fr.email.ccproperty is used.
Email Blind Carbon Copy Recipient:
SINCE Orbeon Forms 2017.1
When selected, the control is used to determine a blind carbon copy email recipient ("Bcc:") when the form data is sent by email.
If more than one non-blank email addresses is found, they are all included as email recipients. In addition, the
oxf.fr.email.bccproperty is used.
Email Sender:
SINCE Orbeon Forms 2017.1
When selected, the control is used to determine an email sender ("From:") when the form data is sent by email.
Only one "From:" email address is used, specifically the first non-blank address selected in the form. If no such address is found the
oxf.fr.email.fromproperty is used.
Exclude from Email Body:
SINCE Orbeon Forms 2018.1
When using "All Control Values" in an email body template, controls selected with this checkbox will be
excluded and omitted from the email body.
Include as Email Attachment:
SINCE Orbeon Forms 2016.1
this option only shows for file and image attachments
when the property
oxf.fr.email.attach-filesis set toselected, only file and image attachments with this option checked are attached to the email
Show in Email Subject:
DEPRECATED with Orbeon Forms 2018.1: Use a template for the subject instead.
When selected, the control value is used as part of the subject of the email when the form data is sent by email.
If more than one non-blank values are found, they are all included in the email subject, comma-separated.
The "Custom CSS Classes" field allows adding CSS classes which will be placed on the control in the resulting HTML. This can be used for custom styling.
Control appearance
[SINCE Orbeon Forms 4.10]
Some controls support more than one appearance. For example, a single selection control can appear as a dropdown menu, or as radio buttons. When available, the "Control Appearance" selector allows selecting and changing the appearance of the control.
See also How the new Form Builder Appearance Selector Works.
Custom control settings
Some controls have custom settings. For example:
See also Control metadata for the Control Settings dialog
Validations and alerts
See Form Builder Validation for details.
Formulas
See Formulas for details.
Label and Hint
[SINCE Orbeon Forms 2017.2]
In addition to setting a control's label and hint in place in the form area, you can also set and update them in this tab. You can switch between plain text and HTML text as well. The "Previous" and "Next" buttons allow quick navigation between controls.
Help Message
This allows specifying some help text, which can be plain text or rich text when the "Use HTML" checkbox is selected.
The help message is available at runtime through a help icon positioned next to the control. By default, the icon opens a pop-up containing the help text. In noscript mode, the icon links to a help section at the bottom of the form.
The help text is localizable.
See also Improving how we show help messages.
See also
Last updated