<GroupTemplate> (RibbonDiffXml)

Article
11/28/2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Specifies a collection of layout definitions that a group can use when the ribbon width changes.

Syntax

<GroupTemplate 
 Id="String"
 ClassName="String">
 <Layout />
</GroupTemplate>

Attributes and Elements

The following table lists the attributes, child elements, and parent elements.

Attributes

Attribute	Description	Type	Usage
ClassName	The name of a CSS class selector to apply to the group.	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

ClassName

The name of a CSS class selector to apply to the group.

String

Optional

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

Child Elements

Element	Description
<Layout> (RibbonDiffXml)	Specifies a layout for a Group within a GroupTemplate.

Parent Elements

Element	Description
<RibbonTemplates> (RibbonDiffXml)	Contains a collection of group templates.

Element Information

XPath	`//RibbonDiffXml/Templates/RibbonTemplates/GroupTemplate`
Schema Name	GroupTemplateType
Validation File	RibbonWSS.xsd
Can be Empty	Yes