Orbeon Forms
Search…
Getting started
Installation
Configuration
Form Builder
Form settings
Form editor
Form area
Toolbox
Control settings
Dependent fields and sections
Validation
Choices editor
Publishing
Cut, copy and paste
Section and grid settings
Section settings
Grid settings
Quick control search
Repeat settings
Repeated grids
Undo and redo
Formulas
Summary page
Form localization
Advanced
Form Runner
XForms
XML Platform
FAQ
Contributors
Release notes
Use cases
Index of features
Release history
Product roadmap
Powered By GitBook
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 Settings tab

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, using the variable notation $foo where foo is the control name
  • to determine an XML element name when the form data is represented as XML
If a control name is not explicitly specified, Form Builder assigns a default name, such as control-42.
A control name can be changed, provided it doesn't collide with another control name (an error will show otherwise). [SINCE Orbeon Forms 2019.1] When renaming a control, all dependent formulas that use the $foo notation, as well as all dependent templates and actions, including when using the new syntax.
Main options
The following options are available:
  • Show on Summary page:
    • 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.
  • Index control:
    • SINCE Orbeon Forms 2021.1
    • Index the value of this control even if it's not shown or searchable from the Summary page. This makes the control accessible from the search API.
  • Encrypt data at rest:
Email options
The following email options are available:
NOTE: SINCE Orbeon Forms 2018.2, these options are in a separate list.
  • 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.to property is used.
    • A single control value can contain more than one email address, separated by commas (,) or spaces.
  • 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.cc property is used.
    • A single control value can contain more than one email address, separated by commas (,) or spaces.
  • 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.bcc property is used.
    • A single control value can contain more than one email address, separated by commas (,) or spaces.
  • 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.from property is used.
  • Email reply-to:
    • SINCE Orbeon Forms 2020.1
    • When selected, the control is used to determine a reply-to address ("Reply-To:") when the form data is sent by email.
    • Only one "Reply-To:" email address is used, specifically the first non-blank address selected in the form. If no such address is found the oxf.fr.email.reply-to property 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-files is set to selected, only file and image attachments with this option checked are attached to the email
  • Show in email subject:
    • DEPRECATED SINCE 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.
[SINCE Orbeon Forms 2021.1.4]
Email addresses can now contain a name, following the standard syntax:
1
John Smith <[email protected]>
Copied!
Or:
1
"John Smith" <[email protected]>
Copied!
When more than one email is present, if you specify names, you must use commas exclusively as a separator (with whitespace allowed around commas):
1
John Smith <[email protected]>, Alice <[email protected]>
Copied!
Or:
1
"John Smith" <[email protected]>, "Alice" <[email protected]>
Copied!

Name of the PDF field

[SINCE Orbeon Forms 2018.2]
This informational field shows the name of the field to use when using a PDF template.
See also PDF templates.

Custom CSS classes

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.
CSS classes don't directly control the style. Instead, they are space-separated tokens, which can then be referred to in your own CSS files.
You could have for example:
1
my-name-field my-highlight
Copied!
In your custom CSS file, you could refer to these classes with a selector, for example:
1
.orbeon .my-name-field.my-highlight input {
2
border-color: blue;
3
}
Copied!
NOTE: The above uses example my- prefixes as it is a good idea to prefix CSS classes to avoid clashes with other CSS classes on the page.

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.

Custom control settings

Some controls have custom settings. For example:
Custom Control Settings
The following controls have custom settings:

Automatic PDF options

[SINCE Orbeon Forms 2021.1]
When producing a PDF file, single-selection controls like the "Static Dropdown" normally just output the selected value. However, in some cases, it is useful for the user to see all the available options.
You can achieve this with the "Automatic PDF" options in the "Control Settings" dialog for single-selection controls. This option is hierarchical: you can set it at the field level, form level, or globally. They are:
  • Use default: use the form settings, and if they also have "Use default" use the property (see below)
  • Show the selected value only: the label for the selected value shows
  • Show all values as radio buttons: all possible values show as radio buttons and the selected value, if any, shows selected
Automatic PDF options
The supported properties are:
  • oxf.xforms.xbl.fr.dropdown-select1.pdf-appearance.*.*
  • oxf.xforms.xbl.fr.'dropdown-select1-search'.pdf-appearance.*.*
The possible values for each property are:
  • empty: show the selected value only (default)
  • full: show all values as radio buttons
Example to change the default the "Static Dropdown" control to showing all values in the automatic PDF:
1
<property
2
as="xs:string"
3
name="oxf.xforms.xbl.fr.dropdown-select1.pdf-appearance.*.*"
4
value="full"/>
Copied!
The global default is "Show the selected value only".

Validations and alerts

Validations and alerts tab
See Form Builder Validation for details.

Formulas

Formulas tab
See Formulas for details.
[SINCE Orbeon Forms 2018.2]
The "Yes" and "No" options have their own radio button. Select "Formula" to enter a dynamic "Visibility" or "Read-Only" formula.

Explanatory Text

[SINCE Orbeon Forms 2019.1]
For the Explanatory Text control only, you can modify the text in this location, including making the text dynamic using templates as is the case for the Label, Hint and Help Message.
Explanatory Text tab

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.
Label tab

Help Message

Help tab
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 (removed since Orbeon Forms 2018.1), the icon links to a help section at the bottom of the form.
The help text is localizable.

Dynamic labels, hints and help messages

[SINCE Orbeon Forms 2018.1]
Controls support dynamic labels, hints, and help messages. This means that, instead of being specified once and for all at form design time, labels, hints and help messages can incorporate dynamic parts such as control values and other custom expressions.
For more, see Template syntax.

See also

Previous
Toolbox
Next
Dependent fields and sections
Last modified 1mo ago
Copy link
Contents
Introduction
Basic Settings
Validations and alerts
Formulas
Explanatory Text
Label and Hint
Help Message
Dynamic labels, hints and help messages
See also