<Label> (RibbonDiffXml)
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Specifies a line of text used to provide information.
Syntax
<Label
Command="String"
ForId="String"
Id="String"
Image16by16="String"
Image16by16Class="String"
Image16by16Left="Non Positive Integer"
Image16by16Top="Non Positive Integer"
LabelText="String"
ModernImage=”String”
QueryCommand="String"
Sequence="Integer"
TemplateAlias="String"
/>
Attributes and Elements
The following table lists the attributes, child elements, and parent elements.
Attributes
Attribute |
Description |
Type |
Usage |
---|---|---|---|
Command |
Specifies the ID of the ribbon command for this control. |
String |
Optional |
ForId |
The ID of the control that this control labels. |
String |
Optional |
Id |
Specifies a unique identifier for the definition of a ribbon element. The strongly recommended naming convention is to use a period to separate the parts of the name like so: [solution identifier].[entity].[ribbon].[function].[element name]. For example: MyISV.account.form.SendToOtherSystem.Button. Use the {!EntityLogicalName} token in the Id attribute when you define a ribbon element that will be used for multiple entities. This inserts the entity logical name into the Id value to make sure that the Id value is globally unique. For example, if you use MyISV.{!EntityLogicalName}.form.SendToOtherSystem.Button with the account entity, the Id will be MyISV.account.form.SendToOtherSystem.Button. For the contact entity, the Id will be MyISV.contact.form.SendToOtherSystem.Button. Important If you don’t set a globally unique Id value, the ribbon might not display. |
String |
Required |
Image16by16 |
Specifies a 16 by 16 pixel image. This can be the path to an image file or it can reference a web resource using the $webresource: directive. |
String |
Optional |
Image16by16Left |
Specifies the number of pixels to move the 16 by 16 pixel image to the left. This is represented by a negative number. |
Non positive integer |
Optional |
Image16by16Top |
Specifies the number of pixels to move the 16 by 16 pixel image toward the top. This is represented by a negative number. |
Non positive integer |
Optional |
LabelText |
Specifies a string to display as the text for the control. This can reference a LocLabel element using the $LocLabels: directive, for example, "$LocLabels:MyISV.account.Save.Button.Label". |
String |
Optional |
ModernImage |
For internal use only. |
String |
Optional |
QueryCommand |
Specifies the name of the command to run when polling for state information. |
String |
Optional |
Sequence |
Specify the location of the ribbon modification by setting the Sequence value higher or lower than existing ribbon elements. |
Integer |
Optional |
TemplateAlias |
Associates a ribbon element child of CommandUIDefinition with a location placeholder within a child of a Layout element. This value defines where the control will display within a group of controls when the layout changes. |
String |
Optional |
Child Elements
This element has no child elements.
Parent Elements
Element |
Description |
---|---|
Specifies the visible Ribbon elements to be included within a CustomAction element. |
Element Information
XPath |
|
Schema Name |
LabelType |
Validation File |
RibbonWSS.xsd |
Can be Empty |
Yes |
See Also
Ribbon XML reference
Customize commands and the ribbon
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright