Steuerelement vom Typ Menü

Ein Menü definiert eine Liste von Optionen. Jedes Menüelement führt eine Funktion aus oder zeigt einen Aufgabenbereich an.

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.

Das Menüsteuerelement definiert:

  • Ein Menüsteuerelement auf Stammebene.
  • Eine Liste der Menüelemente.

Bei Verwendung mit dem PrimaryCommandSurface-Erweiterungspunkt wird das Stammmenüelement als Schaltfläche im Menüband angezeigt. Wenn die Schaltfläche ausgewählt ist, wird das Menü als Dropdownliste angezeigt. Untermenüs werden nicht unterstützt.

Bei Verwendung mit dem ContextMenu-Erweiterungspunkt wird ein Stammmenüelement im Kontextmenü angezeigt. Wenn das Stammelement ausgewählt ist, werden die Menüelemente als Untermenü angezeigt. Keines der Elemente kann selbst ein Untermenü sein, da nur eine Ebene von Untermenüs unterstützt wird.

Untergeordnete Elemente

Element Erforderlich Beschreibung
Label Ja Der Text für das Menü.
Supertip Ja Der Supertipp für dieses Menü.

Wichtig: Supertips werden nur in Office-Desktopclients unterstützt.
Icon Ja Ein Bild für das Menü.
<Elemente> Ja Eine Sammlung von Elementen, die im Menü angezeigt werden sollen. Enthält das <Item-Element> für jeden Artikel.
OverriddenByRibbonApi Nein Gibt an, ob das Menü in Anwendungs- und Plattformkombinationen angezeigt werden soll, die benutzerdefinierte kontextbezogene Registerkarten unterstützen. Wenn es verwendet wird, muss es sich um das erste untergeordnete Element handeln.

Label

Gibt den Text für den Menünamen anhand seines einzigen Attributs resid an, das nicht mehr als 32 Zeichen lang sein darf und auf den Wert des id-Attributs eines <String-Elements> im <ShortStrings-Child-Element> des Resources-Elements festgelegt werden muss.

Add-In-Typ: Aufgabenbereich, Mail

Nur in diesen VersionOverrides-Schemas gültig:

  • Aufgabenbereich 1.0
  • Mail 1.0
  • Mail 1.1

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

Diesen Anforderungssätzen zugeordnet:

  • AddinCommands 1.1 , wenn die übergeordnete <VersionOverrides> vom Typ Taskbereich 1.0 ist.
  • Postfach 1.3 , wenn die übergeordnete <VersionOverrides> vom Typ Mail 1.0 ist.
  • Postfach 1.5 , wenn die übergeordnete <VersionOverrides> vom Typ Mail 1.1 ist.

Beispiele

Im folgenden Beispiel enthält das Menü zwei Elemente. Der erste zeigt einen Aufgabenbereich an. Der zweite führt eine Funktion aus. Das Menü ist so konfiguriert, dass es nicht angezeigt wird, wenn das Add-In auf einer Plattform ausgeführt wird, die kontextbezogene Registerkarten unterstützt. Weitere Informationen finden Sie unter Implementieren einer alternativen Benutzeroberfläche, wenn benutzerdefinierte kontextbezogene Registerkarten nicht unterstützt werden.

<Control xsi:type="Menu" id="Contoso.TestMenu2">
  <OverriddenByRibbonApi>true</OverriddenByRibbonApi>
  <Label resid="residLabel3" />
  <Supertip>
    <Title resid="residLabel" />
    <Description resid="residToolTip" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="icon1_32x32" />
    <bt:Image size="32" resid="icon1_32x32" />
    <bt:Image size="80" resid="icon1_32x32" />
  </Icon>
  <Items>
    <Item id="ShowMainTaskPane">
      <Label resid="residLabel3"/>
      <Supertip>
        <Title resid="residLabel" />
        <Description resid="residToolTip" />
      </Supertip>
      <Icon>
        <bt:Image size="16" resid="icon1_32x32" />
        <bt:Image size="32" resid="icon1_32x32" />
        <bt:Image size="80" resid="icon1_32x32" />
      </Icon>
      <Action xsi:type="ShowTaskpane">
        <TaskpaneId>MyTaskPaneID1</TaskpaneId>
        <SourceLocation resid="residUnitConverterUrl" />
      </Action>
    </Item>
    <Item id="GetData">
      <Label resid="residLabel5"/>
      <Supertip>
        <Title resid="residLabel" />
        <Description resid="residToolTip" />
      </Supertip>
      <Icon>
        <bt:Image size="16" resid="icon4_32x32" />
        <bt:Image size="32" resid="icon4_32x32" />
        <bt:Image size="80" resid="icon4_32x32" />
      </Icon>
      <Action xsi:type="ExecuteFunction">
        <FunctionName>getData</FunctionName>
      </Action>
    </Item>
  </Items>
</Control>

Im folgenden Beispiel ist das zweite Element des Menüs so konfiguriert, dass es nicht sichtbar ist, wenn das Add-In auf einer Plattform ausgeführt wird, die kontextbezogene Registerkarten unterstützt. Weitere Informationen finden Sie unter Implementieren einer alternativen Benutzeroberfläche, wenn benutzerdefinierte kontextbezogene Registerkarten nicht unterstützt werden.

<Control xsi:type="Menu" id="Contoso.msgReadMenuButton">
  <Label resid="menuReadButtonLabel" />
  <Supertip>
    <Title resid="menuReadSuperTipTitle" />
    <Description resid="menuReadSuperTipDescription" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="red-icon-16" />
    <bt:Image size="32" resid="red-icon-32" />
    <bt:Image size="80" resid="red-icon-80" />
  </Icon>
  <Items>
    <Item id="ShowMainTaskPane">
      <Label resid="residLabel3"/>
      <Supertip>
        <Title resid="residLabel" />
        <Description resid="residToolTip" />
      </Supertip>
      <Icon>
        <bt:Image size="16" resid="icon1_32x32" />
        <bt:Image size="32" resid="icon1_32x32" />
        <bt:Image size="80" resid="icon1_32x32" />
      </Icon>
      <Action xsi:type="ShowTaskpane">
        <TaskpaneId>MyTaskPaneID1</TaskpaneId>
        <SourceLocation resid="residUnitConverterUrl" />
      </Action>
    </Item>
    <Item id="msgReadMenuItem1">
      <OverriddenByRibbonApi>true</OverriddenByRibbonApi>
      <Label resid="menuItem1ReadLabel" />
      <Supertip>
        <Title resid="menuItem1ReadLabel" />
        <Description resid="menuItem1ReadTip" />
      </Supertip>
      <Icon>
        <bt:Image size="16" resid="red-icon-16" />
        <bt:Image size="32" resid="red-icon-32" />
        <bt:Image size="80" resid="red-icon-80" />
      </Icon>
      <Action xsi:type="ExecuteFunction">
        <FunctionName>getItemClass</FunctionName>
      </Action>
    </Item>
  </Items>
</Control>