Définir les actions personnalisées pour modifier le ruban

  • Article

Notes

Cette rubrique concerne les commandes classiques.

Il existe une nouvelle façon de définir les commandes. Voir Vue d’ensemble du commandement moderne (Version préliminaire)

Par défaut, une barre de commandes d’application ou le ruban est défini par les métadonnées Microsoft Dataverse. Ces données par défaut ne peuvent pas être modifiées, mais vous pouvez inclure des définitions d’actions spécifiques qui remplaceront le ruban par défaut.

Types d’actions personnalisées

Il existe deux types d’actions personnalisées pour les rubans :

  • <CustomAction> : Définit une action pour ajouter ou remplacer des éléments dans le ruban.

  • <HideCustomAction> : Supprime un élément de ruban existant afin d'empêcher son traitement pour le ruban.

Personnaliser les actions

Une action personnalisée est une instruction sur la manière dont vous souhaitez modifier la définition du ruban par défaut. Elle est évaluée et appliquée au ruban au moment de l’exécution. Pour définir le contexte pour une action personnalisée, vous devez inclure les informations à propos de l’emplacement des éléments que vous souhaitez modifier. Utilisez le paramètre Location pour spécifier où votre modification s’applique.

Lorsque vous souhaitez ajouter un nouveau élément de ruban, vous faites référence à l’élément conteneur, par exemple un onglet ou un groupe existant. Vous ajoutez ensuite le suffixe ._children pour indiquer que cette action personnalisée ajoutera une modification à un élément existant.

Lorsque vous modifiez la définition d’un élément existant, la valeur Location correspondra à l’ID de cet élément.

Vous devez également spécifier un identificateur unique pour l’action personnalisée. Utilisez le paramètre Id pour définir cette valeur. Nous vous recommandons vivement d’utiliser une convention d’affectation de noms qui garantira une valeur unique. Pour la cohérence et la lisibilité, nous recommandons d’utiliser un point pour séparer les composants cohérents. Le premier élément de votre convention d’affectation de noms doit être un élément lié à votre éditeur de solutions ou solution, par exemple, Contoso.contact.form.CustomButton.CustomAction.

Conseil

Le fait d’appliquer de manière cohérente vos conventions d’affectation de paramètre Id permet d’accroître considérablement votre productivité tout en modifiant RibbonDiffXml.

En fonction des informations d’emplacement que vous offrez, la valeur Sequence détermine l’ordre dans lequel afficher les éléments. Si vous souhaitez qu’un contrôle personnalisé apparaisse entre deux contrôles existants, vous devez sélectionner une valeur de séquence qui se situe entre les valeurs de séquence des éléments existants.

Masquer les actions personnalisées

Une <HideCustomAction> est une instruction que vous utilisez lorsque vous souhaitez supprimer un élément de ruban existant, de sorte qu’il ne soit pas affiché. Cela ne masque pas l’élément de ruban, mais supprime en fait l’élément de ruban au moment de l’exécution, afin qu’il disparaisse du ruban.

L’élément HideActionId fournit un ID unique pour l’action. Pour la cohérence et la lisibilité, vous devez suivre la même convention d’affectation de noms décrite pour les éléments <CustomAction>. Le paramètre Emplacement doit correspondre à l’Id de l’élément de ruban à supprimer.

Notes

Parce que l’élément HideCustomAction supprime un nœud spécifié du ruban, la suppression des éléments de ruban de cette manière peut ne pas être la meilleure option pour chaque situation.

  • Si vous souhaitez supprimer un bouton associé à un privilège spécifique, vous devez ajuster les privilèges pour la table dans les rôles de sécurité de votre implémentation. Cela permettra au ruban par défaut de s’afficher et activera les règles pour masquer ou désactiver les éléments du ruban à partir des utilisateurs qui n’ont pas les privilèges nécessaires pour exécuter ces actions.
    • Si vous souhaitez remplacer un élément de ruban existant par un élément de ruban personnalisé, vous pouvez remplacer cet élément en spécifiant une valeur CustomAction.Location identique à l’élément existant.
  • Pour supprimer l’élément HideCustomAction, vous devez créer une nouvelle version mise à jour de la même solution qui a installé l’élément HideCustomAction. Un nouveau correctif de la solution ne peut pas supprimer l’élément HideCustomAction.

L’élément HideCustomAction ne peut pas être supprimé, une fois qu’il a été ajouté, sauf en créant une nouvelle solution mise à jour. Au lieu de cela, les boutons du ruban doivent être masqués à l’aide d’un élément DisplayRule qui est toujours évalué sur False. Si Mscrm.HideOnModern et Mscrm.ShowOnlyOnModern existent tous les deux, le résultat est False. Par exemple, pour masquer un bouton de désactivation :

<CommandDefinition Id="Mscrm.HomepageGrid.Deactivate">
    <EnableRules>
      </EnableRules>
      <DisplayRules>
        <DisplayRule Id="Mscrm.HideOnModern" />
        <DisplayRule Id="Mscrm.ShowOnlyOnModern" />
      </DisplayRules>
      <Actions>
        </Actions>
    </CommandDefinition>

Voir aussi

Personnaliser les commandes et le ruban
Transmettre des données à partir d’une page en tant que paramètre des actions du ruban
Définir la mise à l’échelle pour les éléments de ruban

Notes

Pouvez-vous nous indiquer vos préférences de langue pour la documentation ? Répondez à un court questionnaire. (veuillez noter que ce questionnaire est en anglais)

Le questionnaire vous prendra environ sept minutes. Aucune donnée personnelle n’est collectée (déclaration de confidentialité).