Edit

Share via

UI_PKEY_Label

  • Article

Identifies the UI_PKEY_Label property.

propertyDescription
   name = UI_PKEY_Label
   shellPKey = UI_PKEY_Label
   formatID = 00000004-7363-696e-8441798acf5aebb7
   propID = 4
   typeInfo
      type = VT_LPWSTR

Remarks

UI_PKEY_Label is used by an application to query the label text of tabs, groups, buttons, gallery items, and other Ribbon controls.

Note

Windows 8 and newer: Application Menu button image changed to label: File. We recommend that you do not use File as the label for any of your own tabs.

 

The property value is a 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.

 

Right alignment is not supported.

The maximum length of UI_PKEY_Label is unbounded.

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"/>

Resource Properties

Command.LabelTitle

UI_PKEY_LabelDescription