<SplitButton> (RibbonDiffXml)

 

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

Specifies a control used as both a button and a menu.

Syntax

<SplitButton
 Alt="String"
 CacheMenuVersions="true"
 Command="String"
 CommandMenuClose="String"
 CommandMenuOpen="String"
 CommandType="General"
 Id="String"
 Image16by16="String"
 Image16by16Class="String"
 Image16by16Left="Non Positive Integer"
 Image16by16Top="Non Positive Integer"
 Image32by32="String"
 Image32by32Class="String"
 Image32by32Left="Non Positive Integer"
 Image32by32Top="Non Positive Integer"
 LabelText="String"
 MenuAlt="String"
 MenuCommand="String"
 ModernImage=”String”
 PopulateDynamically=["0" | "1" | "true" | "false"]
 PopulateOnlyOnce=["0" | "1" | "true" | "false"]
 PopulateQueryCommand="String"
 Sequence="Integer"
 TemplateAlias="String"
 ToolTipDescription="String"
 ToolTipHelpKeyWord="String"
 ToolTipImage32by32="String"
 ToolTipImage32by32Class="String"
 ToolTipImage32by32Left="Non Postive Integer"
 ToolTipImage32by32Top="Non Postive Integer"
 ToolTipSelectedItemTitle="String"
 ToolTipShortcutKey="String"
 ToolTipTitle="String"
 >
 <Menu />
</SplitButton>

Attributes and Elements

The following describes the attributes, child elements, and parent elements.

Attributes

Attribute	Description	Type	Usage
Alt	String or reference to a localized label to display as alternative text.	String	Optional
CacheMenuVersions	Indicates whether the definition for the control should be cached for better performance. Select this value if you do not select PopulateDynamically.	String	Optional
Command	Specifies the ID of the ribbon command for this control.	String	Optional
CommandMenuClose	Specifies the ID of the menu command to run when the menu closes.	String	Optional
CommandMenuOpen	Specifies the ID of the ribbon command to run when the menu opens.	String	Optional
CommandType	Allows for specifying a different type of command. Valid values: Value Description General Not a specific type of command. OptionSelection A command that is generated when a user selects one option in an option group. IgnoredByMenu A command that is used for controls that should not close the menu when clicked.	Enumeration	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 are defining a ribbon element that will be used for multiple entities. This will insert 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 Failing to set a globally unique Id value can cause the ribbon not to 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
Image16by16Class	Specifies the name of a CSS class to use for the 16 by 16 pixel image.	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
Image32by32	Specifies a 32 by 32 pixel image. This can be the path to an image file or it can reference a web resource using the $webresource: directive.	String	Optional
Image32by32Class	Specifies the name of a CSS class to use for the 16 by 16 pixel image.	String	Optional
Image32by32Left	Specifies the number of pixels to move the 32 by 32 pixel image to the left. This is represented by a negative number.	Non positive Integer	Optional
Image32by32Top	Specifies the number of pixels to move the 32 by 32 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
MenuAlt	Alternative text to represent the menu.	String	Optional
MenuCommand	The name of the command to execute when the menu is clicked.	String	Optional
ModernImage	For internal use only.	String	Optional
PopulateDynamically	Specifies that the menu elements that provide options for this control will be populated dynamically at run-time using the command defined by the PopulateQueryCommand attribute.	Boolean Default = false.	Optional
PopulateOnlyOnce	When the control is populated dynamically, this setting indicates that the command defined by the PopulateQueryCommand attribute should only be called once.	Boolean Default = false.	Optional
PopulateQueryCommand	When the control is populated dynamically, this command retrieves the menu elements that provide options for this control.	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
ToolTipDescription	Specifies a string to display for the tooltip for a control. This can reference a LocLabel element using the $LocLabels: directive, for example, "$LocLabels:MyISV.account.Save.Button.Tooltip".	String	Optional
ToolTipHelpKeyWord	This element is not used in Microsoft Dynamics 365.	String	Optional
ToolTipImage32by32	Specifies a 32 by 32 pixel image to be displayed with the tooltip.	String	Optional
ToolTipImage32by32Class	Specifies a CSS class to apply to the 32 by 32 pixel image to be displayed with the tooltip.	String	Optional
ToolTipImage32by32Left	Specifies the number of pixels to move the tooltip 32 by 32 pixel image to the left. This is represented by a negative number.	Non positive Integer	Optional
ToolTipImage32by32Top	Specifies the number of pixels to move the tooltip 32 by 32 pixel image to the top. This is represented by a negative number.	Non positive Integer	Optional
ToolTipSelectedItemTitle	This element is not used in Microsoft Dynamics 365.	String	Optional
ToolTipShortcutKey	This element is not used in Microsoft Dynamics 365.	String	Optional
ToolTipTitle	Specifies a string to display for the title of a tooltip for a control. This is typically the same value as the control LabelText. This can reference a LocLabel element using the $LocLabels: directive, for example, "$LocLabels:MyISV.account.Save.Button.Label".	String	Optional

Child Elements

Element	Description
<Menu> (RibbonDiffXml)	Specifies a container used to show pop-up menus.

Parent Elements

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

Remarks

If this element does not have any <Menu> elements and does not have a valid PopulateQueryCommand, the application will throw the following script error at run time: ‘attrs' is null or not an object.

Microsoft Dynamics 365 for tablets does not support adding dynamic elements using PopulateQueryCommand.

Element Information

XPath	//RibbonDiffXml/CustomActions/CustomAction/CommandUIDefinition/SplitButton | //Controls/SplitButton
Schema Name	SplitButtonType
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