<ToggleButton> (RibbonDiffXml)
Specifies a button used to toggle between an on and off state.
<ToggleButton Alt="String" Command="String" CommandValueId="String" Description="String" Id="String" Image16by16="String" Image16by16Class="String" Image16by16Left="Non Positive Integer" Image16by16Top="Non Positive Integer" Image32by32="String" Image32by32Class="String" Image32by32Left="Non Postive Integer" Image32by32Top="Non Positive Integer" LabelCss="String" LabelText="String" MenuItemId="String" QueryCommand="String" Sequence="Integer" TemplateAlias="String" ToolTipDescription="String" ToolTipHelpKeyWord="String" ToolTipImage32by32="String" ToolTipImage32by32Class="String" ToolTipImage32by32Left="Non Positive Integer" ToolTipImage32by32Top="Non Positive Integer" ToolTipShortcutKey="String" ToolTipTitle="String" />
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 |
| Command | Specifies the ID of the ribbon command for this control. | String | Optional |
| CommandValueId | A string that is sent with the command event when the button is clicked. | String | Optional |
| Description | The Description attribute is not used by Microsoft Dynamics CRM. | 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 consistent components like so: [solution identifier].[entity].[ribbon].[function].[element name]. For example: MyISV.account.form.SendToOtherSystem.Button. | 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 |
| LabelCss | Specifies a CSS class to apply to the label for the control. | String | 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 |
| MenuItemId | Specifies a reference from a control to the ID of a menu item. | String | Optional |
| QueryCommand | Specifies the name of the command to execute 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 |
| 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 CRM. | 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 |
| ToolTipShortcutKey | This element is not used in Microsoft Dynamics CRM. | 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
This element has no child elements.
Parent Elements
| Element | Description |
|---|---|
| Specifies the visible Ribbon elements to be included within a CustomAction element. | |
| Contains a collection of controls. |
| XPath |
//RibbonDiffXml/CustomActions/CustomAction/CommandUIDefinition/ToggleButton//RibbonDiffXml/CustomActions/CustomAction/CommandUIDefinition/Controls/ToggleButton//RibbonDiffXml/CustomActions/CustomAction/CommandUIDefinition/Menu/MenuSection/Controls/ToggleButton |
| Schema Name | ToggleButtonType |
| Validation File | RibbonWSS.xsd |
| Can be Empty | Yes |
Send comments about this topic to Microsoft.
© 2012 Microsoft Corporation. All rights reserved.
