Teilen über

Überprüfen der API-Verfügbarkeit zur Laufzeit

Wenn Ihr Add-In ein bestimmtes Erweiterbarkeitsfeature für einen Teil seiner Funktionen verwendet, aber über andere nützliche Funktionen verfügt, für die das Erweiterbarkeitsfeature nicht erforderlich ist, sollten Sie das Add-In so entwerfen, dass es auf Plattform- und Office-Versionskombinationen installiert werden kann, die das Erweiterbarkeitsfeature nicht unterstützen. Es kann eine wertvolle, wenn auch verringerte Erfahrung mit diesen Kombinationen bieten.

Wenn der Unterschied in den beiden Umgebungen vollständig aus Unterschieden in den aufgerufenen Office JavaScript-Bibliotheks-APIs besteht und nicht in features, die im Manifest konfiguriert sind, testen Sie zur Laufzeit, um zu ermitteln, ob der Office-Client des Benutzers einen API-Anforderungssatz unterstützt. Sie können auch zur Laufzeit testen, ob APIs unterstützt werden, die nicht in einer Gruppe enthalten sind.

Hinweis

Um alternative Funktionen mit Features bereitzustellen, die eine Manifestkonfiguration erfordern, befolgen Sie die Anleitung unter Angeben von Office-Hosts und API-Anforderungen mit dem einheitlichen Manifest oder Angeben von Office-Anwendungen und API-Anforderungen mit dem reinen Add-In-Manifest.

Überprüfen auf Anforderungssatzunterstützung

Die isSetSupported-Methode wird verwendet, um die Unterstützung von Anforderungssätzen zu überprüfen. Übergeben Sie den Namen des Anforderungssatzes und die Mindestversion als Parameter. Wenn der Anforderungssatz unterstützt wird, isSetSupported gibt zurück true. Im folgenden Code ist ein Beispiel dargestellt:

if (Office.context.requirements.isSetSupported("WordApi", "1.2")) {
   // Code that uses API members from the WordApi 1.2 requirement set.
} else {
   // Provide diminished experience here.
   // For example, run alternate code when the user's Word is
   // volume-licensed perpetual Word 2016 (which doesn't support WordApi 1.2).
}

Bei diesem Code ist Folgendes zu beachten:

  • Der erste Parameter ist erforderlich. Es handelt sich um eine Zeichenfolge, die den Namen des Anforderungssatzes darstellt. Weitere Informationen zu verfügbaren Anforderungssätzen finden Sie unter Office-Add-In-Anforderungssätze.
  • Der zweite Parameter ist optional. Es handelt sich um eine Zeichenfolge, die die Mindestversion des Anforderungssatzes angibt, die die Office-Anwendung unterstützen muss, damit der Code in der if Anweisung ausgeführt werden kann (z. B. "1.9"). Wenn sie nicht verwendet wird, wird version "1.1" angenommen.

Warnung

Beim Aufrufen der isSetSupported -Methode sollte der Wert des zweiten Parameters (sofern angegeben) eine Zeichenfolge und keine Zahl sein. Der JavaScript-Parser kann nicht zwischen numerischen Werten wie 1.1 und 1.10 unterscheiden, während er für Zeichenfolgenwerte wie "1.1" und "1.10" geeignet ist.

Die folgende Tabelle zeigt die Namen der Anforderungssätze für die anwendungsspezifischen API-Modelle.

Office-Anwendung RequirementSetName
Excel ExcelApi
OneNote OneNoteApi
Outlook Postfach
PowerPoint PowerPointApi
Word WordApi

Im Folgenden finden Sie ein Beispiel für die Verwendung der -Methode mit einem der Allgemeinen API-Modellanforderungssätze.

if (Office.context.requirements.isSetSupported('CustomXmlParts')) {
    // Run code that uses API members from the CustomXmlParts requirement set.
} else {
    // Run alternate code when the user's Office application doesn't support the CustomXmlParts requirement set.
}

Hinweis

Die isSetSupported -Methode und die Anforderungssätze für diese Anwendungen sind in der neuesten Office.js-Datei im CDN verfügbar. Wenn Sie keine Office.js aus dem CDN verwenden, generiert Ihr Add-In möglicherweise Ausnahmen, wenn Sie eine alte Version der Bibliothek verwenden, isSetSupported in der nicht definiert ist. Weitere Informationen finden Sie unter Verwenden der neuesten Office JavaScript-API-Bibliothek.

Überprüfen auf Setless-API-Unterstützung

Wenn Ihr Add-In von einer Methode abhängig ist, die nicht Teil eines Anforderungssatzes ist, der als setless-API bezeichnet wird, verwenden Sie eine Laufzeitüberprüfung, um zu bestimmen, ob die Methode von der Office-Anwendung unterstützt wird, wie im folgenden Codebeispiel gezeigt. Eine vollständige Liste von Methoden, die nicht zum Anforderungssatz gehören, finden Sie unter Office-Add-In-Anforderungssätze.

Hinweis

Es wird empfohlen, die Verwendung dieser Art von Laufzeitüberprüfungen im Code Ihres Add-In einzuschränken.

Im folgenden Codebeispiel wird überprüft, ob die Office-Anwendung unterstützt document.setSelectedDataAsync.

if (Office.context.document.setSelectedDataAsync) {
    // Run code that uses `document.setSelectedDataAsync`.
}

Siehe auch

  • Last updated on