<ToggleButton> (RibbonDiffXml)

適用対象: CRM 2016 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 では使用されません。

String

Optional

Id

リボン要素の定義の一意の識別子を指定します。[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

16 x 16 ピクセルのイメージを指定します。イメージ ファイルのパスを指定できます。または、$webresource: ディレクティブを使用して Web リソースを参照することもできます。

String

Optional

Image16by16Class

16 x 16 ピクセルのイメージに使用する CSS クラスの名前を指定します。

String

Optional

Image16by16Left

16 x 16 ピクセルのイメージを左に移動するためのピクセル数を指定します。これは負の数で表されます。

Non Positive Integer

Optional

Image16by16Top

16 x 16 ピクセルのイメージを先頭に移動するためのピクセル数を指定します。これは負の数で表されます。

Non Positive Integer

Optional

Image32by32

32 x 32 ピクセルのイメージを指定します。イメージ ファイルのパスを指定できます。または、$webresource: ディレクティブを使用して Web リソースを参照することもできます。

String

Optional

Image32by32Class

16 x 16 ピクセルのイメージに使用する CSS クラスの名前を指定します。

String

Optional

Image32by32Left

32 x 32 ピクセルのイメージを左に移動するためのピクセル数を指定します。これは負の数で表されます。

Non Positive Integer

Optional

Image32by32Top

32 x 32 ピクセルのイメージを先頭に移動するためのピクセル数を指定します。これは負の数で表されます。

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

Sequence の値を既存のリボン要素よりも大きく、または小さく設定することによってリボンの変更の場所を指定します。

Integer

Optional

TemplateAlias

Layout 要素の子の中の場所のプレースホルダーに CommandUIDefinition のリボン要素の子を関連付けます。この値は、レイアウトが変更されたときにコントロールのグループ内でコントロールが表示される場所を定義します。

String

Optional

ToolTipDescription

コントロールのツールヒントに表示する文字列を指定します。$LocLabels: ディレクティブを使用すると、LocLabel 要素を参照できます。たとえば、"$LocLabels:MyISV.account.Save.Button.Tooltip" のように指定します。

String

Optional

ToolTipHelpKeyWord

この要素は Microsoft Dynamics CRM では使用されません。

String

Optional

ToolTipImage32by32

ツールヒントに表示する 32 x 32 ピクセルのイメージを指定します。

String

Optional

ToolTipImage32by32Class

ツールヒントに表示する 32 x 32 ピクセルのイメージに適用する CSS クラスを指定します。

String

Optional

ToolTipImage32by32Left

ツールヒントの 32 x 32 ピクセルのイメージを左に移動するためのピクセル数を指定します。これは負の数で表されます。

Non Positive Integer

Optional

ToolTipImage32by32Top

ツールヒントの 32 x 32 ピクセルのイメージを先頭に移動するためのピクセル数を指定します。これは負の数で表されます。

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
コマンドおよびリボンをカスタマイズする

Microsoft Dynamics CRM 2016 and Microsoft Dynamics CRM Online
Send comments about this topic to Microsoft.
© 2015 Microsoft. All rights reserved.