<ToggleButton> (RibbonDiffXml)

项目
12/05/2014

应用到: CRM 2015 on-prem, CRM Online

指定用于在打开和关闭状态之间进行切换的按钮。

语法

<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"
 ModernCommandType=["ControlCommand" | "System"]
 ModernImage=”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.

属性

Attribute Description Type Usage

Alt

用于显示为替代文本的字符串或对本地化标签的引用。

String

Optional

Command

指定此控件的功能区命令的 ID。

String

Optional

CommandValueId

一个字符串，在单击按钮时将与命令事件一起发送。

String

Optional

Description

Microsoft Dynamics CRM 不使用 Description 属性。

String

Optional

指定功能区元素的定义的唯一标识符。强烈推荐的命名约定是使用句点来分隔名称各部分的，如[solution identifier].[entity].[ribbon].[function].[element name]。例如：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

重要

Failing to set a globally unique Id value can cause the ribbon not to display.

String

Required

Image16by16

指定一个 16x16 像素的图像。这可以是某个图像文件的路径，也可以是使用 $webresource: 指令引用 Web 资源。

String

Optional

Image16by16Class

指定要用于 16x16 像素的图像的 CSS 类的名称。

String

Optional

Image16by16Left

指定要将 16x16 像素的图像左移的像素数。此数字可由负数表示。

Non Positive Integer

Optional

Image16by16Top

指定要将 16x16 像素的图像上移的像素数。此数字可由负数表示。

Non Positive Integer

Optional

Image32by32

指定一个 32x32 像素的图像。这可以是某个图像文件的路径，也可以是使用 $webresource: 指令引用 Web 资源。

String

Optional

Image32by32Class

指定要用于 16x16 像素的图像的 CSS 类的名称。

String

Optional

Image32by32Left

指定要将 32x32 像素的图像左移的像素数。此数字可由负数表示。

Non Positive Integer

Optional

Image32by32Top

指定要将 32x32 像素的图像上移的像素数。此数字可由负数表示。

Non Positive Integer

Optional

LabelCss

指定要应用于控件的标签的 CSS 类。

String

Optional

LabelText

指定要显示为控件的文本的字符串。这可以使用 $LocLabels: 指令引用 LocLabel 元素，例如“$LocLabels:MyISV.account.Save.Button.Label”。

String

Optional

MenuItemId

指定从控件到菜单项 ID 的引用。

String

Optional

ModernCommandType

仅供内部使用。

Valid values:

Value	Description
ControlCommand	仅供内部使用。
System	仅供内部使用。

Enumeration

Optional

ModernImage

仅供内部使用。

String

Optional

QueryCommand

指定在轮询状态信息时要运行的命令的名称。

String

Optional

Sequence

通过将序列值设置为高于或低于现有功能区元素来指定功能区修改内容的位置。

Integer

Optional

TemplateAlias

将 CommandUIDefinition 的功能区元素子级与 Layout 元素子级中的位置占位符关联。此值定义了控件在布局发生更改时在控件组中的显示位置。

String

Optional

ToolTipDescription

指定要为控件的工具提示显示的字符串。这可以使用 $LocLabels: 指令引用 LocLabel 元素，例如“$LocLabels:MyISV.account.Save.Button.Tooltip”。

String

Optional

ToolTipHelpKeyWord

Microsoft Dynamics CRM 中未使用此元素。

String

Optional

ToolTipImage32by32

指定一个将与工具提示一起显示的 32x32 像素的图像。

String

Optional

ToolTipImage32by32Class

指定要应用于随工具提示一起显示的 32x32 像素的图像的 CSS 类。

String

Optional

ToolTipImage32by32Left

指定要将工具提示的 32x32 像素的图像左移的像素数。此数字可由负数表示。

Non Positive Integer

Optional

ToolTipImage32by32Top

指定要将工具提示的 32x32 像素的图像上移的像素数。此数字可由负数表示。

Non Positive Integer

Optional

ToolTipShortcutKey

Microsoft Dynamics CRM 中未使用此元素。

String

Optional

ToolTipTitle

指定要为控件的工具提示标题显示的字符串。这通常与控件 LabelText 的值相同。这可以使用 $LocLabels: 指令引用 LocLabel 元素，例如“$LocLabels:MyISV.account.Save.Button.Label”。

String

Optional

子元素

此元素没有子元素。

父元素

Element	Description
<CommandUIDefinition> (RibbonDiffXml)	指定要包含在 CustomAction 元素中的可见 Ribbon 元素。
<Controls> (RibbonDiffXml)	包含一个控件集合。

元素信息

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

另请参阅

其他资源

Ribbon XML reference
自定义命令和功能区