Partager via


<CrmParameter> (RibbonDiffXml)

S'applique à: CRM 2016 on-prem, CRM Online

Représente les données récupérées auprès de l'application Microsoft Dynamics CRM pouvant être transmises en tant que paramètre.

Syntaxe

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

Attributs et éléments

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

Attributs

Attribute Description Type Usage

Name

Représente le nom d'un paramètre de chaîne de requête transmis pour cette valeur lorsqu'un élément Url est utilisé.

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

String

See Remarks

Value

Spécifie la valeur devant être transmise sous la forme d'un paramètre.

Valid values:

 

Value Description

CommandProperties

Objet avec les trois propriétés suivantes : SourceControlId, CommandValueId et 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

Nombre représentant le type unique de l'entité pour un déploiement Microsoft CRM spécifique.

PrimaryEntityTypeName

Chaîne représentant le nom unique d'une entité.

PrimaryItemIds

Tableau de chaînes fournissant les valeurs d'ID GUID pour l'élément principal.

FirstPrimaryItemId

Indique un identificateur GUID en tant que chaîne pour l'enregistrement affiché.

PrimaryControl

Objet référençant le contrôle sélectionné lors de l'exécution de l'action de la commande du ruban.

PrimaryControlId

Chaîne fournissant la valeur d'ID du contrôle sélectionné.

SelectedEntityTypeCode

Nombre représentant le type unique de l'entité pour un enregistrement sélectionné dans une grille. Le code de type d'entité varie entre les déploiements.

SelectedEntityTypeName

Chaîne représentant le nom unique de l'entité pour un enregistrement sélectionné dans une grille.

FirstSelectedItemId

Indique un identificateur GUID en tant que chaîne pour le premier élément sélectionné dans une grille.

SelectedControl

Objet référençant le contrôle sélectionné lors de l'exécution de l'action de la commande du ruban.

SelectedControlSelectedItemCount

Nombre d'éléments sélectionnés dans une grille.

SelectedControlSelectedItemIds

Tableau de chaînes des valeurs d'ID GUID pour tous les éléments sélectionnés dans une grille.

SelectedControlSelectedItemReferences

Tableau d'objets EntityReference représentant tous les éléments non sélectionnés dans la grille.

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

SelectedControlAllItemCount

Nombre indiquant le nombre total d'éléments affichés dans une grille.

SelectedControlAllItemIds

Tableau de chaînes fournissant les valeurs d'ID GUID pour tous les éléments affichés dans une grille.

SelectedControlAllItemReferences

Tableau d'objets EntityReference représentant tous les éléments dans la grille.

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

SelectedControlUnselectedItemCount

Nombre d'éléments non sélectionnés dans une grille.

SelectedControlUnselectedItemIds

Tableau de chaînes des valeurs d'ID GUID pour tous les éléments non sélectionnés dans une grille.

SelectedControlUnselectedItemReferences

Tableau d'objets EntityReference représentant tous les éléments non sélectionnés dans la grille.

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

OrgName

Nom de l'organisation.

OrgLcid

Code de langue représentant la langue de base pour l'organisation.

UserLcid

Code de langue représentant la préférence de langue choisie par l'utilisateur..

Enumeration

Required

Éléments enfants

Cet élément n'a pas d'élément enfant.

Éléments parents

Element Description

<JavaScriptFunction> (RibbonDiffXml)

Spécifie une action appelant une fonction à partir d'une bibliothèque JavaScript spécifique.

<CustomRule> (RibbonDiffXml)

Spécifie une règle utilisée avec une définition EnableRule constituée d'une référence à une fonction dans une bibliothèque JavaScript.

<Url> (RibbonDiffXml)

Action ouvrant une page web à une adresse spécifiée.

Remarques

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.

Notes

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

Notes

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.

Informations sur l'élément

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

Voir aussi

Autres ressources

Personnaliser les commandes et le ruban

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