Command.LabelTitle property

Article
12/11/2020

Represents a label title.

Usage

<Command.LabelTitle>
  child elements
</Command.LabelTitle>

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.LabelTitle 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 
 to specify a line break.

The maximum length is unbounded.

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

Note

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

Command.LabelTitle only supports left alignment.

If a Command is exposed through a menu item and the value of Command.LabelTitle or UI_PKEY_Label contains a letter preceded by an ampersand, as shown in the following example, this letter is treated as both a keytip and a keyboard accelerator for that Command by the Ribbon framework.

<Command Name="cmdNew"
         Symbol="ID_FILE_NEW"
         Comment="New"
         Id="25001"
         LabelTitle="&amp;New"/>

To display an ampersand in a label, escape the special character designation with a double ampersand (&&) as shown in the following example.

<Command Name="cmdOpen"
         Symbol="ID_FILE_OPEN"
         Comment="Open"
         Id="25002"
         LabelTitle="&amp;&amp;Open"/>

Examples

The following example demonstrates the markup for a Command element with a Command.LabelTitle 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]

Share via