Edit

Command.TooltipDescription property

  • Article

Represents a tooltip description.

Usage

<Command.TooltipDescription>
  child elements
</Command.TooltipDescription>

Attributes

There are no attributes.

Child elements

Element Description
String
 May occur at most once

Parent elements

Element
Command

Remarks

Optional.

May occur at most once for each Command.

Command.TooltipDescription can contain a value of type xs:string constrained to any sequence of characters, including white space and line-break characters .

Note

Use the Universal Character Set (UCS) XML character reference &#xA; to specify a line break.

The maximum length is unbounded.

If no value is supplied for Command.TooltipDescription, the String child element is required.

Note

If Command.TooltipDescription contains both a value and a String child element, String takes precedence.

Command.TooltipDescription only supports left alignment.

Examples

The following example demonstrates the markup for a Command element with a Command.TooltipDescription declaration.

<Command>
  <Command.Name>cmdSave</Command.Name>
  <Command.Symbol>ID_FILE_SAVE</Command.Symbol>
  <Command.Comment>Save</Command.Comment>
  <Command.Id>25003</Command.Id>
  <Command.LabelTitle>
    <String>
      <String.Content>Label for Save</String.Content>
      <String.Id>59999</String.Id>
      <String.Symbol>strSave</String.Symbol>
    </String>
  </Command.LabelTitle>
  <Command.TooltipTitle>Tooltip title with &amp;&amp; for Save Command</Command.TooltipTitle>
  <Command.TooltipDescription>Tooltip description for Save Command.</Command.TooltipDescription>
  <Command.Keytip>s1</Command.Keytip>
</Command>

Requirements

Requirement Value
Minimum supported client
 Windows 7 [desktop apps only]
Minimum supported server
 Windows Server 2008 R2 [desktop apps only]

See also

UI_PKEY_TooltipDescription