<CrmParameter> (RibbonDiffXml)

Se aplica a: CRM 2016 on-prem, CRM Online

Representa datos recuperados de la aplicación Microsoft Dynamics CRM que pueden pasarse como un parámetro.

Sintaxis

<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 y elementos

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

Atributos

Attribute Description Type Usage

Name

Representa el nombre de un parámetro de cadena de consulta que pasa para este valor cuando se usa un elemento URL.

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

String

See Remarks

Value

Especifica el valor que va a pasar como un parámetro.

Valid values:

 

Value Description

CommandProperties

Un objeto con las tres propiedades siguientes: SourceControlId, CommandValueId y 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

Un número que representa el tipo único de entidad de una implementación específica de Microsoft CRM.

PrimaryEntityTypeName

Una cadena que representa el nombre único de una entidad.

PrimaryItemIds

Una matriz de cadena que proporciona valores de identificador GUID para el elemento principal.

FirstPrimaryItemId

Proporciona un identificador GUID como cadena para el registro que se está visualizando.

PrimaryControl

Un objeto que hace referencia al control que estaba señalado cuando se ha producido la acción del comando de la cinta de opciones.

PrimaryControlId

Una cadena que proporciona el valor de identificador del control que estaba señalado.

SelectedEntityTypeCode

Un número que representa el tipo único de entidad de un registro seleccionado en una cuadrícula. El código de tipo de entidad variará entre las implementaciones.

SelectedEntityTypeName

Una cadena que representa el nombre único de la entidad de un registro seleccionado en una cuadrícula.

FirstSelectedItemId

Proporciona un identificador GUID como cadena para el primer elemento seleccionado en una cuadrícula.

SelectedControl

Un objeto que hace referencia al control que estaba señalado cuando se ha producido la acción del comando de la cinta de opciones.

SelectedControlSelectedItemCount

El número de elementos seleccionados en una cuadrícula.

SelectedControlSelectedItemIds

Una matriz de cadena de valores de identificadores de GUID para todos los elementos seleccionados en una cuadrícula.

SelectedControlSelectedItemReferences

Una matriz de objetos EntityReference que representa todos los elementos seleccionados de la cuadrícula.

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

SelectedControlAllItemCount

Un número que muestra el número total de elementos mostrados en una cuadrícula.

SelectedControlAllItemIds

Una matriz de cadena que proporciona los valores de identificadores de GUID mostrados en una cuadrícula.

SelectedControlAllItemReferences

Una matriz de objetos EntityReference que representa todos los elementos de la cuadrícula.

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

SelectedControlUnselectedItemCount

El número de elementos sin seleccionar en una cuadrícula.

SelectedControlUnselectedItemIds

Una matriz de cadena de valores de identificadores de GUID para todos los elementos no seleccionados en una cuadrícula.

SelectedControlUnselectedItemReferences

Una matriz de objetos EntityReference que representa todos los elementos no seleccionados de la cuadrícula.

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

OrgName

El nombre de la organización.

OrgLcid

El código de idioma que representa el idioma base de la organización.

UserLcid

El código de idioma que representa la preferencia de idioma elegida por el usuario..

Enumeration

Required

Elementos secundarios

Este elemento no tiene elementos secundarios.

Elementos primarios

Element Description

<JavaScriptFunction> (RibbonDiffXml)

Especifica una acción que llama a una función desde una biblioteca específica de JavaScript.

<CustomRule> (RibbonDiffXml)

Especifica una regla usada con una definición EnableRule compuesta por una referencia a una función en una biblioteca de JavaScript.

<Url> (RibbonDiffXml)

Una acción que abre una página web en una dirección especificada.

Comentarios

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.

Nota

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

Nota

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.

Información del 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

Vea también

Otros recursos

Personalizar los comandos y la cinta de opciones

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