<CrmParameter> (RibbonDiffXml)

  • [アーティクル]

適用対象: CRM 2016 on-prem, CRM Online

Microsoft Dynamics CRM アプリケーションから取得されたデータを表します。このデータはパラメーターとして渡すことができます。

構文

<CrmParameter
 Name = “String”
 Value= ["CommandProperties" |
         "PrimaryEntityTypeCode" |
         "PrimaryEntityTypeName" |
         "PrimaryItemIds" |
         "FirstPrimaryItemId" |
         "PrimaryControl" |
         "PrimaryControlId" |
         "SelectedEntityTypeCode" |
         "SelectedEntityTypeName" |
         "FirstSelectedItemId" |
         "SelectedControl" |
         "SelectedControlSelectedItemCount" |
         "SelectedControlSelectedItemIds" |
         "SelectedControlSelectedItemReferences" |
         "SelectedControlAllItemCount" |
         "SelectedControlAllItemIds" |
         "SelectedControlAllItemReferences" |
         "SelectedControlUnselectedItemCount" |
         "SelectedControlUnselectedItemIds" |
         "SelectedControlUnselectedItemReferences" |
         "OrgName" |
         "OrgLcid" |
         "UserLcid"]
 />

属性と要素

The following table lists the attributes, child elements, and parent elements.

属性

Attribute Description Type Usage

Name

Url 要素を使用するときにこの値のために渡されるクエリ文字列パラメーターの名前を表します。

Represents the name of a query string parameter passed using the <Url> (RibbonDiffXml) element.

String

See Remarks

Value

パラメーターとして渡す値を指定します。

Valid values:

 

Value Description

CommandProperties

SourceControlId、CommandValueId、MenuItemId という 3 つのプロパティを持つオブジェクト

  • SourceControlId : The Id value of the Ribbon control that initiated the event.

  • CommandValueId : A string that is sent with the command event when a button is clicked.

  • MenuItemId: A reference from a control to the Id of a menu item.

Most entities will not return a MenuItemId value. Only the following entities will return this value:

  • BusinessUnit

  • Connection

  • CustomerAddress

  • Equipment

  • Goal

  • InvoiceDetail

  • Mailbox

  • MailMergeTemplate

  • PartnerApplication

  • QueueItem

  • QuoteDetail

  • RoutingRuleItem

  • SalesOrderDetail

  • ServiceAppointment

  • SharePointDocumentLocation

  • SharePointSite

  • Territory

PrimaryEntityTypeCode

Microsoft CRM の特定の展開のエンティティの一意の種類を表す数値。

PrimaryEntityTypeName

エンティティの一意の名前を表す文字列。

PrimaryItemIds

主アイテムの GUID ID の値を提供する文字列配列。

FirstPrimaryItemId

表示するレコードの文字列として 1 つの GUID 識別子を指定します。

PrimaryControl

リボン コマンド アクションが実行されたときにフォーカスがあったコントロールを参照するオブジェクト。

PrimaryControlId

フォーカスがあったコントロールの ID 値を提供する文字列。

SelectedEntityTypeCode

グリッドで選択されているレコードのエンティティの一意の種類を表す数値。エンティティの種類コードは展開によって異なります。

SelectedEntityTypeName

グリッドで選択されているレコードのエンティティの一意の名前を表す文字列。

FirstSelectedItemId

グリッドで最初に選択されたアイテムの文字列として 1 つの GUID 識別子を指定します。

SelectedControl

リボン コマンド アクションが実行されたときにフォーカスがあったコントロールを参照するオブジェクト。

SelectedControlSelectedItemCount

グリッドで選択されているアイテムの数。

SelectedControlSelectedItemIds

グリッドで選択されているすべてのアイテムの GUID ID の値の文字列配列。

SelectedControlSelectedItemReferences

グリッドで選択されているすべてのアイテムを表す EntityReference オブジェクトの配列。

This option is only available when used with the <JavaScriptFunction> (RibbonDiffXml) element.

SelectedControlAllItemCount

グリッドに表示するアイテムの合計数を示す数値。

SelectedControlAllItemIds

グリッドに表示されるすべてのアイテムの GUID ID の値を提供する文字列配列。

SelectedControlAllItemReferences

グリッド内のすべてのアイテムを表す EntityReference オブジェクトの配列。

This option is only available when used with the <JavaScriptFunction> (RibbonDiffXml) element.

SelectedControlUnselectedItemCount

グリッドで選択されていないアイテムの数。

SelectedControlUnselectedItemIds

グリッドで選択されていないすべてのアイテムの GUID ID の値の文字列配列。

SelectedControlUnselectedItemReferences

グリッドで選択されていないすべてのアイテムを表す EntityReference オブジェクトの配列。

This option is only available when used with the <JavaScriptFunction> (RibbonDiffXml) element.

OrgName

組織の名前。

OrgLcid

組織の基本言語を示す言語コード。

UserLcid

ユーザーの言語選択を示す言語コード。.

Enumeration

Required

下位要素

この要素には子要素はありません。

親要素

Element Description

<JavaScriptFunction> (RibbonDiffXml)

特定の JavaScript ライブラリから関数を呼び出すアクションを指定します。

<CustomRule> (RibbonDiffXml)

JavaScript ライブラリ内の関数への参照で構成される EnableRule 定義で使用されるルールを指定します。

<Url> (RibbonDiffXml)

指定されたアドレスの Web ページを開くアクション。

備考

When the CrmParameter is a child of the <Url> (RibbonDiffXml) a Name attribute is required. When the CrmParameter is a child of the <JavaScriptFunction> (RibbonDiffXml) element, the Name attribute is not valid.

注意

  • Value attributes referring to a "Primary..." item refer to the record being viewed in the form.

  • Value attributes referring to the "Selected..." item refer to rows selected within a grid.

When a grid is presented within a form or as an associated view the "Primary.." values refer to the record context in which the grid is displayed. This is true as long as the grid is associated with an entity relationship.

When a grid is displayed independently from any entity relationship, such as in the Homepage grid or if a subgrid is added to a form without being associated with an entity relationship, the "Primary..." values will be null.

注意

Some CrmParameter values pass an EntityReference object. This object contains the following properties:

  • Id: A string of the GUID Id value for the record.

  • Name: A string of the value of the Primary field for the record.

  • TypeCode: A number representing the unique type of entity for the record.

  • TypeName: A string representing the unique name of the entity for the record.

要素情報

XPath

 
//RibbonDiffXml/CommandDefinitions/CommandDefinition/Actions/JavaScriptFunction/CrmParameter |
//RibbonDiffXml/CommandDefinitions/CommandDefinition/Actions/Url/CrmParameter |
//RibbonDiffXml/RuleDefinitions/EnableRules/EnableRule/CustomRule/CrmParameter |
//RibbonDiffXml/RuleDefinitions/EnableRules/EnableRule/OrRule/Or/CustomRule/CrmParameter |
//RibbonDiffXml/RuleDefinitions/DisplayRules/DisplayRule/CustomRule/CrmParameter |
//RibbonDiffXml/RuleDefinitions/DisplayRules/DisplayRule/OrRule/Or/CustomRule/CrmParameter

Schema Name
  • CrmParameterType

  • CrmNamedParameterType

Validation File

RibbonTypes.xsd

Can be Empty

Yes

関連項目

他のリソース

コマンドおよびリボンをカスタマイズする

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