<uicontrol>

A user interface control is a label for an item that allows a person or tool to control an interface, such as a button, field, menu item, or other object.

Usage information

The <uicontrol> element is also used inside a <menucascade> element to identify a sequence of menu choices in a nested menu, such as File > New.

Specialization hierarchy

The <uicontrol> element is specialized from <ph>. It is defined in the user-interface domain module.

Content model

(Text | <data> | <foreign> | <keyword> | <term> | <text> | <image> | <shortcut>)*

Contained by

<menucascade>

Zero or more of the following
  • Text
  • <data>
  • <foreign>
  • <image>
  • <keyword>
  • <shortcut>
  • <term>
  • <text>

Contained by

Inheritance

+ topic/ph ui-d/uicontrol

The <uicontrol> element is specialized from <ph>. It is defined in the ui-domain module.

Attributes

The following attributes are available on this element: universal attributes and @keyref.

The following attributes are available on this element: universal attributes and the attributes defined below.

@keyref
Specifies a key name that acts as a redirectable reference based on a key definition within a map. See STUB CONTENT for information on using this attribute.

For HDITA, the equivalent of @keyref is @data-keyref

Example

This section is non-normative.

The following code sample shows how the <uicontrol> element can be used to identify a button that a user is directed to press:

<p>Press <uicontrol>OK</uicontrol> to continue.</p>