<CheckBox> (RibbonDiffXml)

Makale
11/28/2016

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

Specifies a check box used to select an option.

Syntax

<CheckBox
 Alt="String"
 Command="String"
 Id="String"
 LabelText="String"
 MenuItemId="String"
 QueryCommand="String"
 Sequence="integer"
 TemplateAlias="String"
 ToolTipDescription="String"
 ToolTipHelpKeyWord="String"
 ToolTipImage32by32="String"
 ToolTipImage32by32Class="String"
 ToolTipImage32by32Left="NonPositiveInteger"
 ToolTipImage32by32Top="NonPositiveInteger"
 ToolTipShortcutKey="String"
 ToolTipTitle="String" />

Attributes and Elements

The following table lists 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. A reference to an existing CommandDefinition.Id value.	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
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 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
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. Note This element cannot be associated with a template alias that represents an <OverflowSection> (RibbonDiffXml) or a <ControlRef> (RibbonDiffXml) element that uses the Large display mode.	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
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

This element has no child elements.

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.

Example

<CheckBox Command="MyISV.account.form.SendToOtherSystem.Command" Id="MyISV.account.form.SendToOtherSystem.Button" LabelText="$LocLabels:MyISV.account.SendToOtherSystem.LabelText" TemplateAlias="o2" ToolTipDescription="$LocLabels:MyISV.account.SendToOtherSystem.ToolTip" ToolTipTitle="$LocLabels:MyISV.account.SendToOtherSystem.LabelText" />

Element Information

XPath	`//RibbonDiffXml/CustomActions/CustomAction/CommandUIDefinition/CheckBox \| //RibbonDiffXml/CustomActions/CustomAction/CommandUIDefinition/Controls/CheckBox`
Schema Name	CheckBoxType
Validation File	RibbonWSS.xsd
Can be Empty	Yes

Aracılığıyla paylaş