Élément Control de type Button
Définit un bouton qui exécute une action ou lance un volet Office.
Remarque
Cet article suppose que vous êtes familiarisé avec l’article de référence Control de base 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 bouton doit avoir une valeur d’attribut id
unique parmi tous les <éléments Control> 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 « Button ».
Éléments enfants
Élément | Obligatoire | Description |
---|---|---|
Label | Oui | Texte du bouton. |
Supertip | Oui | Info-bulle pour le bouton. Important : les super-infos ne sont prises 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 Action> d’un <élément Control> . |
Enabled | Non | Spécifie si le contrôle est activé au lancement du complément. |
OverriddenByRibbonApi | Non | Spécifie 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 s’agir du premier élément enfant. |
Étiquette
Spécifie le texte du bouton au moyen de son seul attribut, resid, qui ne peut pas comporter plus de 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 les schémas VersionOverrides suivants :
- 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 :
- AddinCommands 1.1 lorsque le parent <VersionOverrides> est de type Taskpane 1.0.
- Boîte aux lettres 1.3 lorsque le parent <VersionOverrides> est de type Courrier 1.0.
- Boîte aux lettres 1.5 lorsque le parent <VersionOverrides> est de type Mail 1.1.
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, reportez-vous aux Commandes Activé et Désactivé pour les compléments.
<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>