acclabel

Defines a message that is available to active screen readers. When the focus shifts to the item containing the acclabel, the message is read aloud by the screen reader. The message should contain additional information about the item to assist users with vision impairments.

Syntax

   <acclabel>message</acclabel>

Table 1. acclabel parameters
Parameter	Type	Description
message	string	A message that is read aloud to users.

Available in

button, check, checkgroup, combobox, field, list, popup, radio, radiogroup, richtext, slider

Example

The following example shows a field that contains an accessibility message.

   <field sid="firstName">
      <acclabel>Type your first name.</acclabel>
   </field>

When the focus moves to the field, the acclabel message will be passed to the screen reader, which will read "Type your first name" aloud.

Usage details

Default: none
Screen readers normally provide information in addition to the acclabel option. This information is defined by the screen reader in use, and cannot be controlled through XFDL.
If the item contains a label option, the screen reader will read the label option as well as the acclabel option.
If the item has a value option, the screen reader will read the item's value. If the item has a blank value, the screen reader will say that the item is empty.
If the item has associated cells, the screen reader reads the value option of the cells.
If the item contains a help option, the screen reader will read the value of the associated help item. The screen reader will also read this help message if the item contains a format option and the item's content is invalid when the user tries to tab to a new item
If the item contains a format option with a message flag, the screen reader will read the contents of the message flag if the item's content is invalid when the user tries to tab to a new item.
If the item is signed, the screen reader reads the signed message as well as the acclabel option. The signed message is defined by the Viewer and is not modifiable through XFDL.
If you are using a label item to provide information for another item, the acclabel option of the second item should include the contents of the label item. Since label items never receive the focus, screen readers will never read their contents. The acclabel option can provide the same information to users, with further explanation if necessary.

The following table provides the actions which invoke the screen reader and the order in which it reads the messages provided by the form and the Viewer:

Table 2. Table of actions for screen readers.
Action	Viewer Help On	Item is signed	Messages Read by Screen Reader
Item gains focus	No	No	label option + acclabel + value
Item gains focus	Yes	No	label option + acclabel + value + help
Item gains focus	n/a	Yes	label option + acclabel + value + help + signed
Tab out of item failed	n/a	n/a	format + help
Spacebar or arrow keys activate list of choices	n/a	No	cell value