Erstellen von Add-In-Befehlen in Ihrem Manifest für Excel, Word und PowerPointCreate add-in commands in your manifest for Excel, Word, and PowerPoint

Verwenden Sie VersionOverrides in Ihrem Manifest, um Add-In-Befehle für Excel, Word und PowerPoint zu definieren. Add-In-Befehle bieten eine einfache Möglichkeit zum Anpassen der standardmäßigen Office-Benutzeroberfläche mit angegebenen Benutzeroberflächenelementen, die Aktionen ausführen. Sie können Add-In-Befehle für Folgendes verwenden:Use VersionOverrides in your manifest to define add-in commands for Excel, Word, and PowerPoint. Add-in commands provide an easy way to customize the default Office user interface (UI) with specified UI elements that perform actions. You can use add-in commands to:

  • Erstellen von Benutzeroberflächenelementen oder Einstiegspunkten, durch die die Verwendung der Funktionalität Ihres Add-Ins vereinfacht wird.Create UI elements or entry points that make your add-in's functionality easier to use.

  • Hinzufügen von Schaltflächen oder einer Dropdownliste von Schaltflächen zum Menüband.Add buttons or a drop-down list of buttons to the ribbon.

  • Hinzufügen einzelner Menüelemente – jedes mit optionalen Untermenüs – zu bestimmten Kontextmenüs.Add individual menu items — each containing optional submenus — to specific context (shortcut) menus.

  • Ausführen von Aktionen, wenn der Add-In-Befehl gewählt wird. Sie haben die folgenden Möglichkeiten:Perform actions when your add-in command is chosen. You can:

    • Anzeigen eines oder mehrerer Aufgabenbereich-Add-Ins für Benutzer, mit denen diese interagieren können. Innerhalb Ihres Aufgabenbereich-Add-Ins können Sie HTML-Code anzeigen, der Office UI Fabric zum Erstellen einer benutzerdefinierten Benutzeroberfläche verwendet.Show one or more task pane add-ins for users to interact with. Inside your task pane add-in, you can display HTML that uses Office UI Fabric to create a custom UI.

      oderor

    • Ausführen von JavaScript-Code, der normalerweise ohne Anzeige einer Benutzeroberfläche ausgeführt wird.Run JavaScript code, which normally runs without displaying any UI.

In diesem Artikel wird beschrieben, wie Sie Ihre Manifestdatei bearbeiten, um Add-In-Befehle zu definieren. Im folgenden Diagramm ist die Hierarchie von Elementen dargestellt, die zum Definieren von Add-In-Befehlen verwendet werden. Diese Elemente werden in diesem Artikel ausführlicher beschrieben.This article describes how to edit your manifest to define add-in commands. The following diagram shows the hierarchy of elements used to define add-in commands. These elements are described in more detail in this article.

Die folgende Abbildung enthält eine Übersicht der Add-In-Befehlselemente im Manifest. Übersicht der Add-In-Befehlselemente im ManifestThe following image is an overview of add-in commands elements in the manifest. Overview of add-in commands elements in the manifest

Schritt 1: Mit einem Beispiel startenStep 1: Start from a sample

Es wird dringend empfohlen, mit einem Beispiel zu beginnen, das in Office Add-in Commands Samples bereitgestellt wird. Optional können Sie Ihr eigenes Manifest erstellen, indem Sie die Schritte in diesem Handbuch befolgen. Sie können Ihr Manifest anhand der XSD-Datei auf der Office Add-in Commands Samples-Website validieren. Lesen Sie unbedingtAdd-In-Befehle für Excel, Word und PowerPoint, bevor Sie Add-In-Befehle verwenden.We strongly recommend that you start from one of the samples we provide in Office Add-in Commands Samples. Optionally, you can create your own manifest by following the steps in this guide. You can validate your manifest using the XSD file in the Office Add-in Commands Samples site. Ensure that you have read Add-in commands for Excel, Word and PowerPoint before using add-in commands.

Schritt 2: Erstellen eines Aufgabenbereich-Add-InsStep 2: Create a task pane add-in

Um mit der Verwendung von Add-In-Befehlen zu beginnen, müssen Sie zuerst ein Aufgabenbereich-Add-In erstellen und dann das Manifest des Add-Ins wie in diesem Artikel beschrieben ändern. Sie können keine Add-In-Befehle mit Inhalts-Add-Ins verwenden. Wenn Sie ein vorhandenes Manifest aktualisieren, müssen Sie die entsprechenden XML-Namespaces sowie das VersionOverrides-Element zum Manifest hinzufügen, wie in Schritt 3: VersionOverrides-Element hinzufügen beschrieben.To start using add-in commands, you must first create a task pane add-in, and then modify the add-in's manifest as described in this article. You can't use add-in commands with content add-ins. If you're updating an existing manifest, you must add the appropiate XML namespaces as well as add the VersionOverrides element to the manifest as described in Step 3: Add VersionOverrides element.

Das folgende Beispiel zeigt das Manifest eines Office 2013-Add-Ins. Dieses Manifest enthält keine Add-In-Befehle, da kein VersionOverrides-Element vorhanden ist. Office 2013 unterstützt keine Add-In-Befehle, aber durch Hinzufügen von VersionOverrides zu diesem Manifest kann Ihr Add-In in Office 2013 und in Office 2016 ausgeführt werden. In Office 2013 zeigt das Add-In keine Add-In-Befehle an und verwendet den Wert von SourceLocation, um das Add-In als einzelnes Aufgabenbereich-Add-In auszuführen. Wenn Sie kein VersionOverrides-Element einschließen, wird in Office 2016 SourceLocation zum Ausführen des Add-Ins verwendet. Wenn Sie VersionOverrides jedoch einschließen, zeigt das Add-In nur die Add-In-Befehle an; das Add-In wird nicht als einzelnes Aufgabenbereich-Add-In angezeigt.The following example shows an Office 2013 add-in's manifest. There are no add-in commands in this manifest because there is no VersionOverrides element. Office 2013 doesn't support add-in commands, but by adding VersionOverrides to this manifest, your add-in will run in both Office 2013 and Office 2016. In Office 2013, your add-in won't display add-in commands, and uses the value of SourceLocation to run your add-in as a single task pane add-in. In Office 2016, if no VersionOverrides element is included, SourceLocation is used to run your add-in. If you include VersionOverrides, however, your add-in displays the add-in commands only, and doesn't display your add-in as a single task pane add-in.

<OfficeApp xmlns="http://schemas.microsoft.com/office/appforoffice/1.1" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:bt="http://schemas.microsoft.com/office/officeappbasictypes/1.0" xmlns:ov="http://schemas.microsoft.com/office/taskpaneappversionoverrides" xsi:type="TaskPaneApp">
  <Id>657a32a9-ab8a-4579-ac9f-df1a11a64e52</Id>
  <Version>1.0.0.0</Version>
  <ProviderName>Contoso</ProviderName>
  <DefaultLocale>en-US</DefaultLocale>
  <DisplayName DefaultValue="Contoso Add-in Commands" />
  <Description DefaultValue="Contoso Add-in Commands"/>
  <IconUrl DefaultValue="~remoteAppUrl/Images/Icon_32.png" />
 
  <AppDomains>
    <AppDomain>AppDomain1</AppDomain>
    <AppDomain>AppDomain2</AppDomain>
    <AppDomain>AppDomain3</AppDomain>
  </AppDomains>
  <Hosts>
    <Host Name="Workbook" />
  </Hosts>
  <DefaultSettings>
    <SourceLocation DefaultValue="https://www.contoso.com/Pages/Home.aspx" />
  </DefaultSettings>
  <Permissions>ReadWriteDocument</Permissions>

 <!-- The VersionOverrides element is inserted at this location in the manifest. -->

</OfficeApp>

Schritt 3: Hinzufügen des VersionOverrides-ElementsStep 3: Add VersionOverrides element

Das VersionOverrides-Element ist das Stammelement, das die Definition Ihres Add-In-Befehls enthält. VersionOverrides ist ein untergeordnetes Element des OfficeApp-Elements im Manifest. In der folgenden Tabelle werden die Attribute des VersionOverrides-Elements aufgeführt.The VersionOverrides element is the root element that contains the definition of your add-in command. VersionOverrides is a child element of the OfficeApp element in the manifest. The following table lists the attributes of the VersionOverrides element.

AttributAttribute BeschreibungDescription
xmlnsxmlns
Erforderlich.Required. Der Schemaspeicherort, der http://schemas.microsoft.com/office/taskpaneappversionoverrides sein muss.The schema location, which must be http://schemas.microsoft.com/office/taskpaneappversionoverrides.
xsi:typexsi:type
Erforderlich. Die Schemaversion. Die in diesem Artikel beschriebene Version ist "VersionOverridesV1_0".Required. The schema version. The version described in this article is "VersionOverridesV1_0".

In der folgenden Tabelle werden die untergeordneten Elemente von VersionOverrides aufgeführt.The following table identifies the child elements of VersionOverrides.

ElementElement BeschreibungDescription
BeschreibungDescription
Optional. Beschreibt das Add-In. Dieses untergeordnete Description-Element überschreibt ein vorheriges Description-Element im übergeordneten Teil des Manifests. Das resid Attribut für dieses Description-Element ist auf die ID eines String-Elements festgelegt. Das String-Element enthält den Text für das Description-Element. Optional. Describes the add-in. This child Description element overrides a previous Description element in the parent portion of the manifest. The resid attribute for this Description element is set to the id of a String element. The String element contains the text for Description.
AnforderungenRequirements
Optional. Gibt die festgelegten Mindestanforderungen und die Version von Office.js an, die das Add-In erfordert. Das untergeordnete Requirements-Element überschreibt das Requirements-Element im übergeordneten Teil des Manifests. Weitere Informationen finden Sie unter Angeben von Office-Hosts und API-Anforderungen. Optional. Specifies the minimum requirement set and version of Office.js that the add-in requires. This child Requirements element overrides the Requirements element in the parent portion of the manifest. For more information, see Specify Office hosts and API requirements.
HostsHosts
Erforderlich. Gibt eine Sammlung von Office-Hosts an. Das untergeordnete Hosts-Element überschreibt das Hosts-Element im übergeordneten Teil des Manifests. Sie müssen ein xsi:type-Attribut einschließen, das auf „Workbook“ oder „Document“ festgelegt ist. Required. Specifies a collection of Office hosts. The child Hosts element overrides the Hosts element in the parent portion of the manifest. You must include a xsi:type attribute set to "Workbook" or "Document".
ResourcesResources
Definiert eine Sammlung von Ressourcen (Zeichenfolgen, URLs und Bilder), auf die von anderen Elementen des Manifests verwiesen wird. So verweist beispielsweise der Wert des Description-Elements auf ein untergeordnetes Element in Resources. Das Resources-Element wird in Schritt 7: Resources-Element hinzufügen weiter unten in diesem Artikel beschrieben. Defines a collection of resources (strings, URLs, and images) that other manifest elements reference. For example, the Description element's value refers to a child element in Resources. The Resources element is described in Step 7: Add the Resources element later in this article.

Das folgende Beispiel zeigt, wie Sie das VersionOverrides-Element und dessen untergeordnete Elemente verwenden.The following example shows how to use the VersionOverrides element and its child elements.

<OfficeApp>
...
  <VersionOverrides xmlns="http://schemas.microsoft.com/office/taskpaneappversionoverrides" xsi:type="VersionOverridesV1_0">
    <Description resid="residDescription" />
    <Requirements>
      <!-- add information about requirement sets -->
    </Requirements>
    <Hosts>
      <Host xsi:type="Workbook">
        <!-- add information about form factors -->
      </Host>
      <Host xsi:type="Document">
        <!-- add information about form factors -->
      </Host>
    </Hosts>
    <Resources> 
      <!-- add information about resources -->
    </Resources>
  </VersionOverrides>
...
</OfficeApp>

Schritt 4: Hinzufügen von Hosts-, Host- und DesktopFormFactor-ElementenStep 4: Add Hosts, Host, and DesktopFormFactor elements

Das Hosts-Element enthält mindestens ein Host-Element. Ein Host-Element gibt einen bestimmten Office-Host an. Das Host-Element enthält untergeordnete Elemente, die die Add-In-Befehle angeben, die nach der Installation Ihres Add-Ins auf dem betreffenden Office-Host angezeigt werden sollen. Um die gleichen Add-In-Befehle auf zwei oder mehr verschiedenen Office-Hosts anzuzeigen, müssen Sie die untergeordneten Elemente in jedem Host duplizieren.The Hosts element contains one or more Host elements. A Host element specifies a particular Office host. The Host element contains child elements that specify the add-in commands to display after your add-in is installed in that Office host. To show the same add-in commands in two or more different Office hosts, you must duplicate the child elements in each Host.

Das DesktopFormFactor-Element gibt die Einstellungen für ein Add-In an, das in Office im Web (im Browser) und in Windows ausgeführt wird.The DesktopFormFactor element specifies the settings for an add-in that runs in Office on Windows desktop, and Office Online (in browser).

Nachfolgend sehen Sie ein Beispiel von Hosts-, Host- und DesktopFormFactor-Elementen.The following is an example of Hosts, Host, and DesktopFormFactor elements.

<OfficeApp>
...
  <VersionOverrides xmlns="http://schemas.microsoft.com/office/taskpaneappversionoverrides" xsi:type="VersionOverridesV1_0">
  ...
    <Hosts>
      <Host xsi:type="Workbook">
        <DesktopFormFactor>

              <!-- information about FunctionFile and ExtensionPoint -->

        </DesktopFormFactor>
      </Host>
    </Hosts>
  ...
  </VersionOverrides>
...
</OfficeApp>

Schritt 5: Hinzufügen des FunctionFile-ElementsStep 5: Add the FunctionFile element

Das FunctionFile-Element gibt eine Datei an, die JavaScript-Code enthält, der ausgeführt werden soll, wenn ein Add-In-Befehl die ExecuteFunction-Aktion verwendet (unter Steuerelemente für Schaltflächen finden Sie eine Beschreibung). Das resid-Attribut des FunctionFile-Elements ist auf eine HTML-Datei festgelegt, die alle JavaScript-Dateien enthält, die für Ihre Add-In-Befehle erforderlich sind. Es ist nicht möglich, eine direkte Verknüpfung zu einer JavaScript-Datei herzustellen. Sie können nur zu einer HTML-Datei verlinken. Der Dateiname wird als Url-Element im Resources-Element angegeben.The FunctionFile element specifies a file that contains JavaScript code to run when an add-in command uses the ExecuteFunction action (see Button controls for a description). The FunctionFile element's resid attribute is set to a HTML file that includes all the JavaScript files your add-in commands require. You can't link directly to a JavaScript file. You can only link to an HTML file. The file name is specified as a Url element in the Resources element.

Nachfolgend finden Sie ein Beispiel für das FunctionFile-Element.The following is an example of the FunctionFile element.

<DesktopFormFactor>
    <FunctionFile resid="residDesktopFuncUrl" />
    <ExtensionPoint xsi:type="PrimaryCommandSurface">
      <!-- information about this extension point -->
    </ExtensionPoint> 

    <!-- You can define more than one ExtensionPoint element as needed -->
</DesktopFormFactor>

Wichtig

Vergewissern Sie sich, dass Ihr JavaScript-Code Office.initialize aufruft.Make sure your JavaScript code calls Office.initialize.

Der JavaScript-Code in der HTML-Datei, auf die vom FunctionFile-Element verwiesen wird, muss Office.initialize aufrufen. Das FunctionName-Element (unter Steuerelemente für Schaltflächen finden Sie eine Beschreibung) verwendet die Funktionen in FunctionFile.The JavaScript in the HTML file referenced by the FunctionFile element must call Office.initialize. The FunctionName element (see Button controls for a description) uses the functions in FunctionFile.

Im folgenden Code wird gezeigt, wie die von FunctionName verwendete Funktion implementiert wird.The following code shows how to implement the function used by FunctionName.


<script>
    // The initialize function must be run each time a new page is loaded.
    (function () {
        Office.initialize = function (reason) {
            // If you need to initialize something you can do so here.
        };
    })();

    // Your function must be in the global namespace.
    function writeText(event) {

        // Implement your custom code here. The following code is a simple example.  
        Office.context.document.setSelectedDataAsync("ExecuteFunction works. Button ID=" + event.source.id,
            function (asyncResult) {
                var error = asyncResult.error;
                if (asyncResult.status === Office.AsyncResultStatus.Failed) {
                    // Show error message.
                }
                else {
                    // Show success message.
                }
            });

        // Calling event.completed is required. event.completed lets the platform know that processing has completed. 
        event.completed();
    }
</script>

Wichtig

Der Aufruf von event.completed zeigt an, dass Sie das Ereignis erfolgreich bearbeitet haben. Wird eine Funktion mehrmals aufgerufen, beispielsweise durch mehrere Klicks auf denselben Add-In-Befehl, werden alle Ereignisse automatisch in die Warteschlange gestellt. Das erste Ereignis wird automatisch ausgeführt, während die anderen Ereignisse in der Warteschlange verbleiben. Wenn Ihre Funktion event.completed aufruft, wird der nächste Aufruf für diese Funktion in der Warteschlange ausgeführt. Sie müssen event.completed implementieren, andern falls wird die Funktion nicht ausgeführt.The call to event.completed signals that you have successfully handled the event. When a function is called multiple times, such as multiple clicks on the same add-in command, all events are automatically queued. The first event runs automatically, while the other events remain on the queue. When your function calls event.completed, the next queued call to that function runs. You must implement event.completed, otherwise your function will not run.

Schritt 6: Hinzufügen von ExtensionPoint-ElementenStep 6: Add ExtensionPoint elements

Das ExtensionPoint-Element definiert, an welcher Stelle Add-In-Befehle in der Office-Benutzeroberfläche angezeigt werden sollen. Sie können ExtensionPoint-Elemente mit diesen xsi:type-Werten definieren:The ExtensionPoint element defines where add-in commands should appear in the Office UI. You can define ExtensionPoint elements with these xsi:type values:

  • PrimaryCommandSurface – bezieht sich auf das Menüband in Office.PrimaryCommandSurface, which refers to the ribbon in Office.

  • ContextMenu – das Kontextmenü, das angezeigt wird, wenn Sie mit der rechten Maustaste auf die Office-Benutzeroberfläche klicken.ContextMenu, which is the shortcut menu that appears when you right-click in the Office UI.

In den folgenden Beispielen wird gezeigt, wie Sie das ExtensionPoint-Element mit PrimaryCommandSurface- und ContextMenu-Attributwerten verwenden, und welche untergeordneten Elemente für jedes Element verwendet werden sollten.The following examples show how to use the ExtensionPoint element with PrimaryCommandSurface and ContextMenu attribute values, and the child elements that should be used with each.

Wichtig

Geben Sie bei Elementen, die ein ID-Attribut enthalten, eine eindeutige ID an. Es wird empfohlen, dass Sie den Namen Ihres Unternehmens zusammen mit Ihrer ID verwenden. Verwenden Sie zum Beispiel folgendes Format: <CustomTab id="mycompanyname.mygroupname">.For elements that contain an ID attribute, make sure you provide a unique ID. We recommend that you use your company's name along with your ID. For example, use the following format: <CustomTab id="mycompanyname.mygroupname">.

<ExtensionPoint xsi:type="PrimaryCommandSurface">
  <CustomTab id="Contoso Tab">
  <!-- If you want to use a default tab that comes with Office, remove the above CustomTab element, and then uncomment the following OfficeTab element -->
  <!-- <OfficeTab id="TabData"> -->
    <Label resid="residLabel4" />
    <Group id="Group1Id12">
      <Label resid="residLabel4" />
      <Icon>
        <bt:Image size="16" resid="icon1_32x32" />
        <bt:Image size="32" resid="icon1_32x32" />
        <bt:Image size="80" resid="icon1_32x32" />
      </Icon>
      <Tooltip resid="residToolTip" />
      <Control xsi:type="Button" id="Button1Id1">

        <!-- information about the control -->
      </Control>
      <!-- other controls, as needed -->
    </Group>
  </CustomTab>
</ExtensionPoint>
<ExtensionPoint xsi:type="ContextMenu">
  <OfficeMenu id="ContextMenuCell">
    <Control xsi:type="Menu" id="ContextMenu2">
            <!-- information about the control -->
    </Control>
    <!-- other controls, as needed -->
  </OfficeMenu>
</ExtensionPoint>
ElementElement BeschreibungDescription
CustomTabCustomTab
Erforderlich, wenn Sie eine benutzerdefinierte Registerkarte zum Menüband hinzufügen möchten (unter Verwendung von PrimaryCommandSurface). Wenn Sie das CustomTab-Element verwenden, können Sie das OfficeTab-Element nicht verwenden. Das id-Attribut ist erforderlich. Required if you want to add a custom tab to the ribbon (using PrimaryCommandSurface). If you use the CustomTab element, you can't use the OfficeTab element. The id attribute is required.
OfficeTabOfficeTab
Erforderlich, wenn Sie eine standardmäßige Office-Menübandregisterkarte (unter Verwendung von PrimaryCommandSurface) erweitern möchten. Wenn Sie das OfficeTab-Element verwenden, können Sie das CustomTab-Element nicht verwenden. Required if you want to extend a default Office ribbon tab (using PrimaryCommandSurface). If you use the OfficeTab element, you can't use the CustomTab element.
Informationen zu weiteren Registerkartenwerten zur Verwendung mit dem id-Attribut finden Sie unter Registerkartenwerte für standardmäßige Office-Menübandregisterkarten.For more tab values to use with the id attribute, see Tab values for default Office ribbon tabs.
OfficeMenuOfficeMenu
Erforderlich, wenn Sie Add-In-Befehle zu einem Standardkontextmenü (unter Verwendung von ContextMenu) hinzufügen. Das id-Attribut muss festgelegt werden auf: Required if you're adding add-in commands to a default context menu (using ContextMenu). The id attribute must be set to:
ContextMenuText für Excel oder Word. Zeigt das Element im Kontextmenü an, wenn Text ausgewählt wird und der Benutzer dann mit der rechten Maustaste auf den ausgewählten Text klickt. ContextMenuText for Excel or Word. Displays the item on the context menu when text is selected and then the user right-clicks on the selected text.
ContextMenuCell für Excel. Zeigt das Element im Kontextmenü an, wenn der Benutzer mit der rechten Maustaste auf eine Zelle im Arbeitsblatt klickt. ContextMenuCell for Excel. Displays the item on the context menu when the user right-clicks on a cell on the spreadsheet.
GroupGroup
Eine Gruppe von Erweiterungspunkten der Benutzeroberfläche auf einer Registerkarte. Eine Gruppe kann bis zu sechs Steuerelemente enthalten. Das id-Attribut ist erforderlich. Es ist eine Zeichenfolge mit maximal 125 Zeichen. A group of user interface extension points on a tab. A group can have up to six controls. The id attribute is required. It's a string with a maximum of 125 characters.
LabelLabel
Erforderlich. Die Bezeichnung der Gruppe. Das resid-Attribut muss auf den Wert des id-Attributs eines String-Elements festgelegt sein. Das String-Element ist ein untergeordnetes Element des ShortStrings-Elements, und dieses ist wiederum ein untergeordnetes Element des Resources-Elements. Required. The label of the group. The resid attribute must be set to the value of the id attribute of a String element. The String element is a child element of the ShortStrings element, which is a child element of the Resources element.
IconIcon
Erforderlich. Gibt das Symbol der Gruppe an, das auf kleinen Geräten verwendet werden soll oder wenn zu viele Schaltflächen angezeigt werden. Das resid-Attribut muss auf den Wert des id-Attributs eines Image-Elements festgelegt sein. Das Image-Element ist ein untergeordnetes Element des Images-Elements, und dieses ist wiederum ein untergeordnetes Element des Resources-Elements. Das size-Attribut gibt die Größe des Bilds in Pixel an. Drei Bildgrößen sind erforderlich: 16, 32 und 80. Fünf optionale Größen werden ebenfalls unterstützt: 20, 24, 40, 48 und 64. Required. Specifies the group's icon to be used on small form factor devices, or when too many buttons are displayed. The resid attribute must be set to the value of the id attribute of an Image element. The Image element is a child element of the Images element, which is a child element of the Resources element. The size attribute gives the size, in pixels, of the image. Three image sizes are required: 16, 32, and 80. Five optional sizes are also supported: 20, 24, 40, 48, and 64.
TooltipTooltip
Optional. Die QuickInfo der Gruppe. Das resid-Attribut muss auf den Wert des id-Attributs eines String-Elements festgelegt sein. Das String-Element ist ein untergeordnetes Element des LongStrings-Elements, und dieses ist wiederum ein untergeordnetes Element des Resources-Elements. Optional. The tooltip of the group. The resid attribute must be set to the value of the id attribute of a String element. The String element is a child element of the LongStrings element, which is a child element of the Resources element.
ControlControl
Für jede Gruppe ist mindestens ein Steuerelement erforderlich. Ein Control-Element kann entweder eine Button oder ein Menu sein. Verwenden Sie Menu, um eine Dropdownliste von Steuerelemente für Schaltflächen anzugeben. Derzeit werden nur Schaltflächen und Menüs unterstützt. Weitere Informationen finden Sie in den Abschnitten Steuerelemente für Schaltflächen und Menüsteuerelemente.Each group requires at least one control. A Control element can be either a Button or a Menu. Use Menu to specify a drop-down list of button controls. Currently, only buttons and menus are supported. See the Button controls and Menu controls sections for more information.
Hinweis Zur Erleichterung der Fehlerbehebung wird empfohlen, dass das Control-Element und die zugehörigen untergeordneten Resources-Elemente jeweils einzeln hinzugefügt werden.Note: To make troubleshooting easier, we recommend that you add a Control element and the related Resources child elements one at a time.

Steuerelemente für SchaltflächenButton controls

Eine Schaltfläche führt bei Auswahl durch den Benutzer eine einzelne Aktion aus. Sie kann entweder eine JavaScript-Funktion ausführen oder einen Aufgabenbereich anzeigen. Das folgende Beispiel zeigt, wie Sie zwei Schaltflächen definieren. Mit der ersten Schaltfläche wird eine JavaScript-Funktion ohne Anzeige einer Benutzeroberfläche ausgeführt, und mit der zweiten Schaltfläche wird ein Aufgabenbereich angezeigt. Im Control-Element gilt Folgendes:A button performs a single action when the user selects it. It can either execute a JavaScript function or show a task pane. The following example shows how to define two buttons. The first button runs a JavaScript function without showing a UI, and the second button shows a task pane. In the Control element:

  • Das type-Attribut ist erforderlich und muss auf Button festgelegt werden.The type attribute is required, and must be set to Button.

  • Das id-Attribut des Control-Elements ist eine Zeichenfolge mit maximal 125 Zeichen.The id attribute of the Control element is a string with a maximum of 125 characters.

<!-- Define a control that calls a JavaScript function. -->
<Control xsi:type="Button" id="Button1Id1">
  <Label resid="residLabel" />
  <Tooltip resid="residToolTip" />
  <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="ExecuteFunction">
    <FunctionName>getData</FunctionName>
  </Action>
</Control>

<!-- Define a control that shows a task pane. -->
<Control xsi:type="Button" id="Button2Id1">
  <Label resid="residLabel2" />
  <Tooltip resid="residToolTip" />
  <Supertip>
    <Title resid="residLabel" />
    <Description resid="residToolTip" />
  </Supertip>
  <Icon>
    <bt:Image size="16" resid="icon2_32x32" />
    <bt:Image size="32" resid="icon2_32x32" />
    <bt:Image size="80" resid="icon2_32x32" />
  </Icon>
  <Action xsi:type="ShowTaskpane">
    <SourceLocation resid="residUnitConverterUrl" />
  </Action>
</Control>
ElementeElements BeschreibungDescription
LabelLabel
Erforderlich. Der Text für die Schaltfläche. Das resid-Attribut muss auf den Wert des id-Attributs eines String-Elements festgelegt sein. Das String-Element ist ein untergeordnetes Element des ShortStrings-Elements, und dieses ist wiederum ein untergeordnetes Element des Resources-Elements. Required. The text for the button. The resid attribute must be set to the value of the id attribute of a String element. The String element is a child element of the ShortStrings element, which is a child element of the Resources element.
TooltipTooltip
Optional. Die QuickInfo für die Schaltfläche. Das resid-Attribut muss auf den Wert des id-Attributs eines String-Elements festgelegt sein. Das String-Element ist ein untergeordnetes Element des LongStrings-Elements, und dieses ist wiederum ein untergeordnetes Element des Resources-Elements. Optional. The tooltip for the button. The resid attribute must be set to the value of the id attribute of a String element. The String element is a child element of the LongStrings element, which is a child element of the Resources element.
SupertipSupertip
Erforderlich. Der SuperTip für diese Schaltfläche, der mit Folgendem definiert wird Required. The supertip for this button, which is defined by the following:
TitleTitle
Erforderlich. Der Text für den Supertip. Das resid-Attribut muss auf den Wert des id-Attributs eines String-Elements festgelegt sein. Das String-Element ist ein untergeordnetes Element des ShortStrings-Elements, und dieses ist wiederum ein untergeordnetes Element des Resources-Elements. Required. The text for the supertip. The resid attribute must be set to the value of the id attribute of a String element. The String element is a child element of the ShortStrings element, which is a child element of the Resources element.
BeschreibungDescription
Erforderlich. Die Beschreibung für den Supertip. Das resid-Attribut muss auf den Wert des id-Attributs eines String-Elements festgelegt sein. Das String-Element ist ein untergeordnetes Element des LongStrings-Elements, und dieses ist wiederum ein untergeordnetes Element des Resources-Elements. Required. The description for the supertip. The resid attribute must be set to the value of the id attribute of a String element. The String element is a child element of the LongStrings element, which is a child element of the Resources element.
IconIcon
Erforderlich. Enthält die Image-Elemente für die Schaltfläche. Bilddateien müssen das PNG-Format aufweisen. Required. Contains the Image elements for the button. Image files must be .png format.
ImageImage
Definiert ein Bild, das auf der Schaltfläche angezeigt werden soll. Das resid-Attribut muss auf den Wert des id-Attributs eines Image-Elements festgelegt sein. Das Image-Element ist ein untergeordnetes Element des Images-Elements, und dieses ist wiederum ein untergeordnetes Element des Resources-Elements. Das size-Attribut gibt die Größe des Bilds in Pixel an. Drei Bildgrößen sind erforderlich: 16, 32 und 80. Fünf optionale Größen werden ebenfalls unterstützt: 20, 24, 40, 48 und 64. Defines an image to display on the button. The resid attribute must be set to the value of the id attribute of an Image element. The Image element is a child element of the Images element, which is a child element of the Resources element. The size attribute indicates the size, in pixels, of the image. Three image sizes are required: 16, 32, and 80. Five optional sizes are also supported: 20, 24, 40, 48, and 64.
AktionAction
Erforderlich. Gibt die Aktion an, die ausgeführt werden soll, wenn der Benutzer die Schaltfläche auswählt. Für das xsi:type-Attribut kann einer der folgenden Werte angegeben werden: Required. Specifies the action to perform when the user selects the button. You can specify one of the following values for the xsi:type attribute:
ExecuteFunction, wodurch eine JavaScript-Funktion in der Datei ausgeführt wird, auf die von FunctionFile verwiesen wird. ExecuteFunction zeigt keine Benutzeroberfläche an. Das untergeordnete FunctionName-Element gibt den Namen der auszuführenden Funktion an.ExecuteFunction, which runs a JavaScript function located in the file referenced by FunctionFile. ExecuteFunction does not display a UI. The FunctionName child element specifies the name of the function to execute.
ShowTaskPane, womit ein Aufgabenbereich-Add-In angezeigt wird. Das untergeordnete SourceLocation-Element gibt den Speicherort der Quelldatei des Aufgabenbereich-Add-Ins an, das angezeigt werden soll. Das resid-Attribut muss auf den Wert des id-Attributs eines Url-Elements im Urls-Element des Resources-Elements festgelegt sein. ShowTaskPane, which shows a task pane add-in. The SourceLocation child element specifies the source file location of the task pane add-in to display. The resid attribute must be set to the value of the id attribute of a Url element in the Urls element in the Resources element.

Ein Menu-Steuerelement kann entweder mit PrimaryCommandSurface oder ContextMenu verwendet werden und definiert:A Menu control can be used with either PrimaryCommandSurface or ContextMenu, and defines:

  • Ein Menüelement auf der Stammebene.A root-level menu item.

  • Eine Liste von Untermenüelementen.A list of submenu items.

Bei Verwendung mit PrimaryCommandSurface wird das Stammmenüelement als Schaltfläche auf dem Menüband angezeigt. Bei Auswahl der Schaltfläche wird das Untermenü als Dropdownliste angezeigt. Bei Verwendung mit ContextMenu wird ein Menüelement mit einem Untermenü im Kontextmenü eingefügt. In beiden Fällen können einzelne Untermenüelemente entweder eine JavaScript-Funktion ausführen oder einen Aufgabenbereich anzeigen. Derzeit wird nur eine Ebene von Untermenüs unterstützt.When used with PrimaryCommandSurface, the root menu item displays as a button on the ribbon. When the button is selected, the submenu displays as a drop-down list. When used with ContextMenu, a menu item with a submenu is inserted on the context menu. In both cases, individual submenu items can either execute a JavaScript function or show a task pane. Only one level of submenus is supported at this time.

Das folgende Beispiel zeigt, wie ein Menüelement mit zwei Untermenüelementen definiert wird. Das erste Untermenüelement zeigt einen Aufgabenbereich an, das zweite Untermenüelement führt eine JavaScript-Funktion aus. Im Control-Element gilt Folgendes:The following example shows how to define a menu item with two submenu items. The first submenu item shows a task pane, and the second submenu item runs a JavaScript function. In the Control element:

  • Das xsi:type-Attribut ist erforderlich und muss auf Menu festgelegt werden.The xsi:type attribute is required, and must be set to Menu.

  • Das id-Attribut ist eine Zeichenfolge mit maximal 125 Zeichen.The id attribute is a string with a maximum of 125 characters.


<Control xsi:type="Menu" id="TestMenu2">
  <Label resid="residLabel3" />
  <Tooltip resid="residToolTip" />
  <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="showGallery2">
      <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="showGallery3">
      <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>getButton</FunctionName>
      </Action>
    </Item>
  </Items>
</Control>
ElementeElements BeschreibungDescription
LabelLabel
Erforderlich. Der Text des Stammmenüelements. Das resid-Attribut muss auf den Wert des id-Attributs eines String-Elements festgelegt sein. Das String-Element ist ein untergeordnetes Element des ShortStrings-Elements, und dieses ist wiederum ein untergeordnetes Element des Resources-Elements. Required. The text of the root menu item. The resid attribute must be set to the value of the id attribute of a String element. The String element is a child element of the ShortStrings element, which is a child element of the Resources element.
TooltipTooltip
Optional. Die QuickInfo für das Menü. Das resid-Attribut muss auf den Wert des id-Attributs eines String-Elements festgelegt sein. Das String-Element ist ein untergeordnetes Element des LongStrings-Elements, und dieses ist wiederum ein untergeordnetes Element des Resources-Elements. Optional. The tooltip for the menu. The resid attribute must be set to the value of the id attribute of a String element. The String element is a child element of the LongStrings element, which is a child element of the Resources element.
SuperTipSuperTip
Erforderlich. Der SuperTip für das Menü, der mit Folgendem definiert wird Required. The supertip for the menu, which is defined by the following:
TitleTitle
Erforderlich. Der Text für den Supertip. Das resid-Attribut muss auf den Wert des id-Attributs eines String-Elements festgelegt sein. Das String-Element ist ein untergeordnetes Element des ShortStrings-Elements, und dieses ist wiederum ein untergeordnetes Element des Resources-Elements. Required. The text of the supertip. The resid attribute must be set to the value of the id attribute of a String element. The String element is a child element of the ShortStrings element, which is a child element of the Resources element.
BeschreibungDescription
Erforderlich. Die Beschreibung für den Supertip. Das resid-Attribut muss auf den Wert des id-Attributs eines String-Elements festgelegt sein. Das String-Element ist ein untergeordnetes Element des LongStrings-Elements, und dieses ist wiederum ein untergeordnetes Element des Resources-Elements. Required. The description for the supertip. The resid attribute must be set to the value of the id attribute of a String element. The String element is a child element of the LongStrings element, which is a child element of the Resources element.
IconIcon
Erforderlich. Enthält die Image-Elemente für das Menü. Bilddateien müssen das PNG-Format aufweisen. Required. Contains the Image elements for the menu. Image files must be .png format.
ImageImage
Ein Bild für das Menü. Das resid-Attribut muss auf den Wert des id-Attributs eines Image-Elements festgelegt sein. Das Image-Element ist ein untergeordnetes Element des Images-Elements, und dieses ist wiederum ein untergeordnetes Element des Resources-Elements. Das size-Attribut gibt die Größe des Bilds in Pixel an. Drei Bildgrößen (in Pixel) sind erforderlich: 16, 32 und 80. Fünf optionale Größen (in Pixel) werden ebenfalls unterstützt: 20, 24, 40, 48 und 64. An image for the menu. The resid attribute must be set to the value of the id attribute of an Image element. The Image element is a child element of the Images element, which is a child element of the Resources element. The size attribute indicates the size in pixels of the image. Three image sizes, in pixels, are required: 16, 32, and 80. Five optional sizes, in pixels, are also supported: 20, 24, 40, 48, and 64.
ItemsItems
Erforderlich. Enthält die Item-Elemente für jedes Untermenüelement. Jedes Item-Element enthält die gleichen untergeordneten Elemente als Steuerelemente für Schaltflächen. Required. Contains the Item elements for each submenu item. Each Item element contains the same child elements as Button controls.

Schritt 7: Hinzufügen des Resources-ElementsStep 7: Add the Resources element

Das Resources-Element enthält Ressourcen, die von den verschiedenen untergeordneten Elementen des VersionOverrides-Elements verwendet werden. Zu Ressourcen gehören Symbole, Zeichenfolgen und URLs. Ein Element im Manifest kann eine Ressource durch einen Verweis auf die ID der Ressource verwenden. Die Verwendung der ID unterstützt Sie beim Organisieren des Manifests, insbesondere dann, wenn es verschiedene Versionen der Ressource für verschiedene Gebietsschemas gibt. Eine ID darf maximal 32 Zeichen enthalten.The Resources element contains resources used by the different child elements of the VersionOverrides element. Resources include icons, strings, and URLs. An element in the manifest can use a resource by referencing the id of the resource. Using the id helps organize the manifest, especially when there are different versions of the resource for different locales. An id has a maximum of 32 characters.

Im Folgenden finden Sie ein Beispiel für die Verwendung des Resources-Elements. Jede Ressource kann ein oder mehrere untergeordnete Override-Elemente umfassen, um eine andere Ressource für ein bestimmtes Gebietsschema zu definieren.The following shows an example of how to use the Resources element. Each resource can have one or more Override child elements to define a different resource for a specific locale.

<Resources>
  <bt:Images>
    <bt:Image id="icon1_16x16" DefaultValue="https://www.contoso.com/Images/icon_default.png">
      <bt:Override Locale="ja-jp" Value="https://www.contoso.com/Images/ja-jp16-icon_default.png" />
    </bt:Image>
    <bt:Image id="icon1_32x32" DefaultValue="https://www.contoso.com/Images/icon_default.png">
      <bt:Override Locale="ja-jp" Value="https://www.contoso.com/Images/ja-jp32-icon_default.png" />
    </bt:Image>
    <bt:Image id="icon1_80x80" DefaultValue="https://www.contoso.com/Images/icon_default.png">
      <bt:Override Locale="ja-jp" Value="https://www.contoso.com/Images/ja-jp80-icon_default.png" />
    </bt:Image>
  </bt:Images>
  <bt:Urls>
    <bt:Url id="residDesktopFuncUrl" DefaultValue="https://www.contoso.com/Pages/Home.aspx">
      <bt:Override Locale="ja-jp" Value="https://www.contoso.com/Pages/Home.aspx" />
    </bt:Url>
  </bt:Urls>
  <bt:ShortStrings>
    <bt:String id="residLabel" DefaultValue="GetData">
      <bt:Override Locale="ja-jp" Value="JA-JP-GetData" />
    </bt:String>
  </bt:ShortStrings>
  <bt:LongStrings>
    <bt:String id="residToolTip" DefaultValue="Get data for your document.">
      <bt:Override Locale="ja-jp" Value="JA-JP - Get data for your document." />
    </bt:String>
  </bt:LongStrings>
</Resources>
ResourceResource BeschreibungDescription
Images/ ImageImages/ Image
Stellt die HTTPS-URL zu einer Bilddatei bereit. Jedes Bild muss die drei erforderlichen Bildgrößen definieren:Provides the HTTPS URL to an image file. Each image must define the three required image sizes:
16 x 1616×16
32 x 3232×32
80 × 8080×80
Die folgenden Bildgrößen werden ebenfalls unterstützt, sind aber nicht erforderlich:The following image sizes are also supported, but not required:
20 × 2020×20
24 x 2424×24
40 × 4040×40
48 × 4848×48
64 x 6464×64
Urls/ UrlUrls/ Url
Stellt eine HTTPS-URL bereit. Eine URL kann maximal 2.048 Zeichen lang sein.Provides an HTTPS URL location. A URL can be a maximum of 2048 characters.
ShortStrings/ StringShortStrings/ String
Der Text für Label- und Title-Elemente. Jede Zeichenfolge enthält maximal 125 Zeichen. The text for Label and Title elements. Each String contains a maximum of 125 characters.
LongStrings/ StringLongStrings/ String
Der Text für die Elemente Tooltip und Description. Jede String enthält maximal 250 Zeichen.The text for Tooltip and Description elements. Each String contains a maximum of 250 characters.

Hinweis

Sie müssen Secure Sockets Layer (SSL) für alle URLs in den Image and Url-Elementen verwenden.You must use Secure Sockets Layer (SSL) for all URLs in the Image and Url elements.

Registerkartenwerte für standardmäßige Office-MenübandregisterkartenTab values for default Office ribbon tabs

In Excel und Word können Sie Ihre Add-In-Befehle auf dem Menüband mithilfe der standardmäßigen Office-Benutzeroberflächen-Registerkarten hinzufügen. In der folgenden Tabelle sind die Werte aufgeführt, die Sie für das id-Attribut des OfficeTab-Elements verwenden können. Bei den Registerkartenwerten wird die Groß- und Kleinschreibung beachtet.In Excel and Word, you can add your add-in commands to the ribbon by using the default Office UI tabs. The following table lists the values that you can use for the id attribute of the OfficeTab element. The tab values are case sensitive.

Office-HostanwendungOffice host application RegisterkartenwerteTab values
ExcelExcel
TabHome TabInsert TabPageLayoutExcel TabFormulas TabData TabReview TabView TabDeveloper TabAddIns TabPrintPreview TabBackgroundRemovalTabHome TabInsert TabPageLayoutExcel TabFormulas TabData TabReview TabView TabDeveloper TabAddIns TabPrintPreview TabBackgroundRemoval
WordWord
TabHome TabInsert TabWordDesign TabPageLayoutWord TabReferences TabMailings TabReviewWord TabView TabDeveloper TabAddIns TabBlogPost TabBlogInsert TabPrintPreview TabOutlining TabConflicts TabBackgroundRemoval TabBroadcastPresentationTabHome TabInsert TabWordDesign TabPageLayoutWord TabReferences TabMailings TabReviewWord TabView TabDeveloper TabAddIns TabBlogPost TabBlogInsert TabPrintPreview TabOutlining TabConflicts TabBackgroundRemoval TabBroadcastPresentation
PowerPointPowerPoint
TabHome TabInsert TabDesign TabTransitions TabAnimations TabSlideShow TabReview TabView TabDeveloper TabAddIns TabPrintPreview TabMerge TabGrayscale TabBlackAndWhite TabBroadcastPresentation TabSlideMaster TabHandoutMaster TabNotesMaster TabBackgroundRemoval TabSlideMasterHomeTabHome TabInsert TabDesign TabTransitions TabAnimations TabSlideShow TabReview TabView TabDeveloper TabAddIns TabPrintPreview TabMerge TabGrayscale TabBlackAndWhite TabBroadcastPresentation TabSlideMaster TabHandoutMaster TabNotesMaster TabBackgroundRemoval TabSlideMasterHome

Siehe auchSee also