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.

Example

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

Contains

Doctype	Content model
ditabase, topic, task, reference, concept, glossary	( text data or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or term or data or data-about or foreign or unknown or image or shortcut) (any number)

Contained by

Doctype	Parents
ditabase	data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, stentry, draft-comment, fn, cite, xref, entry, abstract, section, example, linkinfo, prereq, context, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, propdesc, glossterm, glossdef, menucascade, screen, b, u, i, tt, sup, sub, codeph, codeblock, pt, pd, fragref, synnote
topic	data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, stentry, draft-comment, fn, cite, xref, entry, abstract, section, example, linkinfo, menucascade, screen, b, u, i, tt, sup, sub, codeph, codeblock, pt, pd, fragref, synnote
task	data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, stentry, draft-comment, fn, cite, xref, entry, abstract, section, example, linkinfo, prereq, context, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, menucascade, screen, b, u, i, tt, sup, sub, codeph, codeblock, pt, pd, fragref, synnote
concept	data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, stentry, draft-comment, fn, cite, xref, entry, abstract, section, example, linkinfo, menucascade, screen, b, u, i, tt, sup, sub, codeph, codeblock, pt, pd, fragref, synnote
reference	data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, stentry, draft-comment, fn, cite, xref, entry, abstract, section, example, linkinfo, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, propdesc, menucascade, screen, b, u, i, tt, sup, sub, codeph, codeblock, pt, pd, fragref, synnote
glossary	data, title, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, stentry, draft-comment, fn, cite, xref, entry, abstract, section, example, linkinfo, glossterm, glossdef, 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?
%univ-atts; (%select-atts;, %id-atts;, %localization-atts;)	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, keyref	Common attributes described in Other common DITA attributes