Use localized labels with ribbons

Note

This topic is about classic commands.

There is a new way to define commands. See Modern commanding overview (preview).

Although Ribbon elements that display text allow for direct entry of text, it is a best practice to use localized labels to define text displayed in the ribbon. This enables multi-language capabilities and better management of shared text.

Using localized labels

The <RibbonDiffXml> element includes the <LocLabels> element. As shown in the following example, this is where you can specify which text to display in the ribbon labels and tooltips using the <Titles> element.

<LocLabels>  
 <LocLabel Id="MyISV.account.SendToOtherSystem.LabelText">  
  <Titles>  
   <Title languagecode="1033"  
          description="Send to Other System" />  
  </Titles>  
 </LocLabel>  
 <LocLabel Id="MyISV.account.SendToOtherSystem.ToolTip">  
  <Titles>  
   <Title languagecode="1033"  
          description="Sends this Record to another system" />  
  </Titles>  
 </LocLabel>  
</LocLabels>  

Within the definition of a ribbon element that displays text, the following example show how the localized label can be referenced using the $LocLabels: directive.

ToolTipTitle="$LocLabels:MyISV.account.SendToOtherSystem.LabelText"  
ToolTipDescription="$LocLabels:MyISV.account.SendToOtherSystem.ToolTip"  

Force a line break in a ribbon control label

If you have a ribbon control label that is very long, the text will wrap to fit the available space. You can specify where you want to include a line break by using the following characters: ​​.

If the label text is very long without a space for the text to wrap, the width of the control expands to allow for the entire label to be displayed.

See also

Customize commands and the ribbon
Export, prepare to edit, and import the Ribbon
Use localized labels with Ribbons
Define Ribbon Commands