Edit online

Oxygen XML Web Author Form Controls

Oxygen XML Web Author supports a variety of built-in form controls that allow users to interact with documents with familiar user interface objects. The oxy_label function is also supported and can be used to change the style of generated text.

For information about implementing custom form controls in Web Author, see Tutorial: Implementing a Custom Form Control.

Table 1. Supported Properties for Form Controls and Functions in Oxygen XML Web Author
Form Control Description Supported Properties
Button form control This form control provides a button object that is used to invoke a specific action.

color
actionID
transparent

Note: If you set an action ID as a property, you can also set the property's name, description, and icon to override the action name, tooltip, and icon path from the referenced action id.
Button Group form control This form control provides a group of button objects that are used to invoke specific actions.

label
icon
actionDisplayStyle
tooltips
transparent

Checkbox form control This form control offers a single checkbox or multiple checkboxes that can be used to enable or disable an option.

editresultSeparator
tooltips
values
uncheckedValues
labels
color

Combo Box form control This form control provides a graphical object that is a drop-down menu of proposed values. It can also be used for a combination of a drop-down menu and an editable single-line text field.

editcolumns
editable
tooltips
values
fontInherit (always true)
labels
color

Date Picker form control
Note: Some browsers interpret the HTML5 datePicker as a text-field.
This form control offers a text field that allows the user to choose a date in a specified format. Some browsers include a calendar browsing mechanism along with the text field.

editcolumns
color
format

HTML Content form control This form control is used for rendering HTML content. It is displayed as a graphical element shaped as a box. The shape of the box is determined by a specified width and the height is computed based on the length of the text.

href
ID
width

Pop-up form control This form control offers a contextual menu that provides quick access to various actions. A pop-up form control can display single or multiple selections.

editcolor
tooltips
values
resultSeparator
selectionMode
labels
columns
rendererSort (has to be identical to editorSort)

Text Area form control This form control provides a text box that can be used to enter multiple lines of text.

edit
columns (in average character width)
rows
fontInherit
color

Text Field form control This form control provides a text field box that is used for entering a single line of text.

edit
columns
fontInherit (always true)
tooltip
color

URL Chooser form control This form control provides a dialog box that allows you to select the location of local or remote resources. The inserted reference is made relative to the URL of the currently open editor.

editcolumns
color
fontInherit (always true)

Browser form control This form control provides a mechanism for integrating HTML frames or interacting with SVG documents directly in the visual editor.
Note: This form control renders the page with a "secure" attribute on the iframe so that the browser will not run any JavaScript from the page.
Restriction: This form control only loads external pages that do not pass through Web Author to load (i.e. files from a CMS).

hrefwidth
height

oxy_label() function This function can be used as a value for the CSS content property to change the style of generated text.

text
width
color
background-color
inherit
styles

Resources

For more information about form controls, watch our video demonstration: