<Gallery> (RibbonDiffXml)

Article
11/28/2016

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

Deprecated: Specified a control that displays a collection of related controls in the Ribbon. If there are too many items in the gallery, an expand arrow is provided to display the rest of the collection in a pane.

Important

This control was deprecated in Microsoft Dynamics CRM 2011. This control will not render with Microsoft Dynamics 365 (online & on-premises).

Syntax

<Gallery 
 Command="String"
 CommandPreview="String"
 CommandRevert="String"
 ElementDimensions=
 ["Size16by16" | 
  "Size32by32" |
  "Size48by48" |
  "Size64by48" |
  "Size72by96" |
  "Size96by72" |
  "Size96by96" |
  "Size128by128" |
  "Size190by30" |
  "Size190by40" |
  "Size190by50" |
  "Size190by60"]
 Id="String"
 QueryCommand="String"
 Sequence="Integer"
 Width="Integer" >
 <GalleryButton />
</Gallery>

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
CommandPreview	Specifies the ID of the ribbon command to run when the cursor hovers over the control before it is selected.	String	Optional
CommandRevert	Specifies the ID of the ribbon command to run when the user selects undo.	String	Optional
ElementDimensions	Controls the size of a Gallery or GalleryButton element. Valid values: Size16by16 Size32by32 Size48by48 Size64by48 Size72by96 Size96by72 Size96by96 Size128by128 Size190by30 Size190by40 Size190by50 Size190by60	Enumeration	Required
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
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
Width	Specifies a desired width for the control in pixels.	Integer	Required

Child Elements

Element	Description
<GalleryButton> (RibbonDiffXml)	Deprecated: Specified a button control within a gallery element.

Parent Elements

Element	Description
<CommandUIDefinition> (RibbonDiffXml)	Specifies the visible Ribbon elements to be included within a CustomAction element.
<MenuSection> (RibbonDiffXml)	Specifies a section used to divide a menu. A menu section can have a title and contain controls.

Element Information

XPath	`//RibbonDiffXml/CustomActions/CustomAction/CommandUIDefinition/Gallery \| //RibbonDiffXml/CustomActions/CustomAction/CommandUIDefinition/MenuSection/Gallery \| //Menu/MenuSection/Gallery`
Schema Name	GalleryType
Validation File	RibbonWSS.xsd
Can be Empty	No

Share via