<CrmParameter> (RibbonDiffXml)

Aplica-se a: CRM 2016 on-prem, CRM Online

Representa os dados recuperados do aplicativo do Microsoft Dynamics CRM que pode ser passado como parâmetro.

Sintaxe

<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"]
 />

Atributos e elementos

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

Atributos

Attribute Description Type Usage

Name

Representa o nome de um parâmetro de cadeia de consulta passado para este valor ao usar um elemento Url.

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

String

See Remarks

Value

Especifica o valor a ser passado como um parâmetro.

Valid values:

 

Value Description

CommandProperties

Um objeto com estas três propriedades: SourceControlId, CommandValueId e MenuItemId

  • 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

Um número que representa o tipo exclusivo da entidade para uma implantação específica do Microsoft CRM.

PrimaryEntityTypeName

Uma cadeia de caracteres que representa o nome exclusivo de uma entidade.

PrimaryItemIds

Uma matriz de cadeia de caracteres de ID de GUID do Item Principal.

FirstPrimaryItemId

Fornece um identificador de GUID como uma cadeia de caracteres do registro que está sendo exibido.

PrimaryControl

Um Objeto que referencia o Controle que tinha o foco quando a ação Comando da Faixa de Opções ocorreu.

PrimaryControlId

Uma cadeia de caracteres que fornece o valor de ID do controle que tinha o foco.

SelectedEntityTypeCode

Um número que representa o tipo exclusivo da entidade para um registro selecionado em uma grade. O código do tipo de Entidade variará de acordo com as implantações.

SelectedEntityTypeName

Uma cadeia de caracteres que representa o nome exclusivo da entidade para um registro selecionado em uma grade.

FirstSelectedItemId

Fornece um identificador de GUID como uma cadeia de caracteres para o primeiro item selecionado em uma grade.

SelectedControl

Um Objeto que referencia o Controle que tinha o foco quando a ação Comando da Faixa de Opções ocorreu.

SelectedControlSelectedItemCount

O número de itens selecionados em uma grade.

SelectedControlSelectedItemIds

Uma matriz de cadeia de caracteres de valores de ID de GUID para todos os itens selecionados em uma grade.

SelectedControlSelectedItemReferences

Uma matriz de objetos EntityReference que representam todos os itens selecionados na grade.

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

SelectedControlAllItemCount

Um número que indica o total de itens exibidos em uma grade.

SelectedControlAllItemIds

Uma matriz de cadeia de caracteres que fornece os valores de ID de GUID para todos os itens exibidos em uma grade.

SelectedControlAllItemReferences

Uma matriz de objetos EntityReference que representa todos os itens da grade.

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

SelectedControlUnselectedItemCount

O número de itens não selecionados em uma grade.

SelectedControlUnselectedItemIds

Uma matriz de cadeia de caracteres de valores de ID de GUID para todos os itens não selecionados em uma grade.

SelectedControlUnselectedItemReferences

Uma matriz de objetos EntityReference que representam todos os itens não selecionados na grade.

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

OrgName

O nome da organização.

OrgLcid

O Código de Idioma que representa o Idioma base da organização.

UserLcid

O Código de Idioma que representa a preferência de idioma escolhida pelo usuário..

Enumeration

Required

Elementos filho

Este elemento não tem elementos filho.

Elemento pai

Element Description

<JavaScriptFunction> (RibbonDiffXml)

Especifica uma ação que chama uma função em uma biblioteca JavaScript específica.

<CustomRule> (RibbonDiffXml)

Especifica uma regra usada com uma definição EnableRule composta por uma referência a uma função em uma biblioteca JavaScript.

<Url> (RibbonDiffXml)

Uma ação que abre uma página da Web em um endereço especificado.

Comentários

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.

Observação

  • 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.

Observação

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.

Informações do elemento

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

Consulte também

Outros recursos

Personalizar os comandos e a faixa de opções

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