uicontrol

The user interface control (<uicontrol>) element is used to mark up names of buttons, entry fields, menu items, or other objects that allow the user to control the interface. Use the <uicontrol> element inside a <menucascade> element to identify a sequence of menu choices in a nested menu, such as File > New. This element is part of the DITA user interface domain, a special set of DITA elements designed to document user interface tasks, concepts and reference information.

Contains

( text data or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or term or image or shortcut) (any number)

Contained by

title, shortdesc, section, example, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, stentry, draft-comment, fn, cite, xref, linkinfo, entry, prereq, context, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, propdesc, menucascade, screen, b, u, i, tt, sup, sub, codeph, codeblock, pt, pd, fragref, synnote

Inheritance

topic/ph, ui-d/uicontrol

Attributes

Name	Description	Data Type	Default Value	Required?
keyref	Currently not implemented in DITA processors. Provides a key that a process can use to look up associated information.	NMTOKEN	#IMPLIED	No
%univ-atts; (%select-atts;, %id-atts;, translate, xml:lang)	A set of related attributes, described at %univ-atts;	parameter entity	PE not applicable	Not applicable
%global-atts; (xtrf, xtrc)	A set of related attributes, described at %global-atts;	parameter entity	PE not applicable	Not applicable
class, outputclass	Common attributes described in Other common DITA attributes

Example

Press the <uicontrol>OK</uicontrol> button.