Steuerelement des Typs Schaltfläche

  • Artikel

Definiert eine Schaltfläche, die eine Aktion ausführt oder einen Aufgabenbereich startet.

Hinweis

In diesem Artikel wird vorausgesetzt, dass Sie mit dem grundlegenden Referenzartikel zu Steuerelementen vertraut sind, der wichtige Informationen zu den Attributen des Elements enthält.

Eine Schaltfläche führt eine einzelne Aktion durch, wenn der Benutzer auf die Schaltfläche klickt. Sie kann entweder eine Funktion ausführen oder einen Aufgabengereich anzeigen. Jedes Schaltflächensteuerelement muss über einen id Attributwert verfügen, der für alle <Control-Elemente> im Manifest eindeutig ist.

Wichtig

Steuerelemente vom Typ "Schaltfläche" werden auf mobilen Plattformen ignoriert. Um mobile Plattformen zu unterstützen, müssen Sie auch über ein Steuerelement vom Typ "MobileButton" für jedes Steuerelement vom Typ "Button" verfügen.

Untergeordnete Elemente

Element Erforderlich Beschreibung
Label Ja Der Text für die Schaltfläche.
Supertip Ja Die Multiinfo für die Schaltfläche.

Wichtig: Supertips werden nur in Office-Desktopclients unterstützt.
Icon Ja Ein Bild für die Schaltfläche.
Action Ja Gibt die auszuführende Aktion an. Es kann nur ein <untergeordnetes Action-Element> eines <Control-Elements> sein.
Enabled Nein Gibt an, ob das Steuerelement aktiviert ist, wenn das Add-In gestartet wird.
OverriddenByRibbonApi Nein Gibt an, ob die Schaltfläche auf Anwendungs- und Plattformkombinationen angezeigt werden soll, die benutzerdefinierte kontextbezogene Registerkarten unterstützen. Bei Verwendung muss es das erste untergeordnete Element sein.

Label

Gibt den Text für die Schaltfläche mithilfe des einzigen Attributs resid an, das nicht mehr als 32 Zeichen lang sein darf und auf den Wert des id-Attributs eines <String-Elements> im <untergeordneten ShortStrings-Element> des Resources-Elements festgelegt werden muss.

Add-In-Typ: Aufgabenbereich, E-Mail

Nur in den folgenden VersionOverrides-Schemas gültig:

  • Aufgabenbereich 1.0
  • Mail 1.0
  • Mail 1.1

Weitere Informationen finden Sie unter Versionsüberschreibungen im reinen Add-In-Manifest.

Diesen Anforderungssätzen zugeordnet:

  • AddinCommands 1.1 , wenn der übergeordnete <VersionOverrides-Typ> Taskpane 1.0 ist.
  • Postfach 1.3 , wenn die übergeordnete <VersionOverrides> den Typ Mail 1.0 hat.
  • Postfach 1.5 , wenn die übergeordnete <VersionOverrides> den Typ Mail 1.1 hat.

Beispiele

Im folgenden Beispiel führt die Schaltfläche eine Funktion aus. Sie ist auch so konfiguriert, dass sie deaktiviert wird, wenn das Add-In gestartet wird. Sie kann programmgesteuert aktiviert werden. Weitere Informationen finden Sie unter Aktivieren und Deaktivieren von Add-In-Befehlen.

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

Im folgenden Beispiel zeigt die Schaltfläche einen Aufgabenbereich an.

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