This topic has not yet been rated - Rate this topic

<Group> (RibbonDiffXml)

[Applies to: Microsoft Dynamics CRM 2011 and Microsoft Dynamics CRM Online]

Specifies a group of controls within a tab that share a common layout template.

<Group 
 Command="String"
 Description="String"
 Id="String"
 Image32by32Popup="String"
 Image32by32PopupClass="String"
 Image32by32PopupLeft="Non Positive Integer"
 Image32by32PopupTop="Non Positive Integer"
 PopupWidth ="String"
 Sequence="Integer"
 Template="String"
 Title="String" >
 <Controls />
</Group>

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

Description

The Description attribute is not used by Microsoft Dynamics CRM.

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

Image32by32Popup

Specifies the 32 by 32 pixel image displayed when a group is displayed as pop-up list in the ribbon. This can be the path to an image file or it can reference a web resource using the $webresource: directive.

String

Optional

Image32by32PopupClass

The name of a CSS class selector to be applied to the image.

String

Optional

Image32by32PopupLeft

A negative integer that represents an offset for the left edge of the image. Use this attribute when the Image32by32Popup attribute points to an image file that contains images for many icons. The value of the Image32by32PopupLeft attribute is used to set the CSS left attribute for the inline style of an HTML img tag.

Non Positive Integer

Optional

Image32by32PopupTop

A negative integer that represents an offset for the top edge of the image. Use this attribute when the Image32by32Popup attribute points to an image file that contains images for many icons. The value of the Image32by32PopupTop attribute is used to set the CSS top attribute for the inline style of an HTML img tag.

Non Positive Integer

Optional

PopupWidth

The width of the popup to display in pixels.

String

Optional

Sequence

Specify the location of the ribbon modification by setting the Sequence value higher or lower than existing ribbon elements.

Integer

Optional

Template

A string that corresponds to the Id attribute of a <GroupTemplate> (RibbonDiffXml) element.

String

Optional

Title

The text to include in the label for the group.

String

Optional

Child Elements

Element	Description
<Controls> (RibbonDiffXml)	Contains a collection of controls.

Parent Elements

Element	Description
<CommandUIDefinition> (RibbonDiffXml)	Specifies the visible Ribbon elements to be included within a CustomAction element.
<Groups> (RibbonDiffXml)	Contains a collection of Group elements.

Element Information

XPath	Copy //RibbonDiffXml/CustomActions/CustomAction/CommandUIDefinition/Group \| //RibbonDiffXml/CustomActions/CustomAction/CommandUIDefinition/Groups/Group
Schema Name	GroupType
Validation File	RibbonWSS.xsd
Can be Empty	No

Other Resources

Customize the Ribbon

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD