Élément de contrôle de type Bouton

Définit un bouton qui exécute une action ou lance un volet Office.

Remarque

Cet article suppose une familiarité avec l’article de référence de base sur le contrôle qui contient des informations importantes sur les attributs de l’élément.

Un bouton effectue une action unique quand il est sélectionné. Il peut exécuter une fonction ou afficher un volet Office. Chaque contrôle de bouton doit avoir une id valeur d’attribut unique parmi tous les <éléments de contrôle> du manifeste.

Importante

Les contrôles de type « bouton » sont ignorés sur les plateformes mobiles. Pour prendre en charge les plateformes mobiles, vous devez également disposer d’un contrôle de type « MobileButton » pour chaque contrôle de type « Bouton ».

Éléments enfants

Élément Obligatoire Description
Label Oui Texte du bouton.
Supertip Oui Info-bulle pour le bouton.

Important : les Supertips ne sont pris en charge que dans les clients de bureau Office.
Icon Oui Image du bouton.
Action Oui Spécifie l’action à effectuer. Il ne peut y avoir qu’un <seul enfant> d’action d’un <élément de contrôle> .
Enabled Non Indique si le contrôle est activé au lancement du complément.
OverriddenByRibbonApi Non Indique si le bouton doit apparaître sur les combinaisons d’applications et de plateformes qui prennent en charge les onglets contextuels personnalisés. S’il est utilisé, il doit être le premier élément enfant.

Étiquette

Spécifie le texte du bouton au moyen de son seul attribut, resid, qui ne peut pas dépasser 32 caractères et doit être défini sur la valeur de l’attribut id d’un <élément String> dans l’enfant <ShortStrings> de l’élément Resources .

Type de complément : Volet Office, Courrier

Valide uniquement dans ces schémas VersionOverrides :

  • Volet De tâches 1.0
  • Mail 1.0
  • Courrier 1.1

Pour plus d’informations, consultez Remplacements de version dans le manifeste du complément uniquement.

Associé à ces ensembles de conditions requises :

Exemples

Dans l’exemple suivant, le bouton exécute une fonction. Il est également configuré pour être désactivé au lancement du complément. Il peut être activé par programmation. Pour plus d’informations, consultez Modifier la disponibilité des commandes de complément.

<Control xsi:type="Button" id="Contoso.msgReadFunctionButton">
  <OverriddenByRibbonApi>true</OverriddenByRibbonApi>
  <Label resid="funcReadButtonLabel" />
  <Supertip>
    <Title resid="funcReadSuperTipTitle" />
    <Description resid="funcReadSuperTipDescription" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="blue-icon-16" />
    <bt:Image size="32" resid="blue-icon-32" />
    <bt:Image size="80" resid="blue-icon-80" />
  </Icon>
  <Action xsi:type="ExecuteFunction">
    <FunctionName>getSubject</FunctionName>
  </Action>
  <Enabled>false</Enabled>
</Control>

Dans l’exemple suivant, le bouton affiche un volet Office.

<Control xsi:type="Button" id="Contoso.msgReadOpenPaneButton">
  <Label resid="paneReadButtonLabel" />
  <Supertip>
    <Title resid="paneReadSuperTipTitle" />
    <Description resid="paneReadSuperTipDescription" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="green-icon-16" />
    <bt:Image size="32" resid="green-icon-32" />
    <bt:Image size="80" resid="green-icon-80" />
  </Icon>
  <Action xsi:type="ShowTaskpane">
    <SourceLocation resid="readTaskPaneUrl" />
  </Action>
</Control>