Office.ContextInformation interface
Stellt Informationen zu der Umgebung bereit, in der das Add-In ausgeführt wird.
Hinweise
Wichtig: In Outlook ist dieses Objekt ab Postfachanforderungssatz 1.5 verfügbar. Für alle Postfachanforderungssätze können Sie die Office.context.mailbox.Diagnose-Eigenschaft verwenden, um ähnliche Informationen abzurufen.
Verwendet von
Eigenschaften
| host | Ruft die Office-Anwendung ab, in der das Add-In ausgeführt wird. |
| platform | Ruft die Plattform ab, auf der das Add-In ausgeführt wird. |
| version | Ruft die Version von Office ab, auf der das Add-In ausgeführt wird. |
Details zur Eigenschaft
host
Ruft die Office-Anwendung ab, in der das Add-In ausgeführt wird.
host: Office.HostType;
Eigenschaftswert
Beispiele
const contextInfo = Office.context.diagnostics;
console.log("Office application: " + contextInfo.host);
platform
Ruft die Plattform ab, auf der das Add-In ausgeführt wird.
platform: Office.PlatformType;
Eigenschaftswert
Hinweise
Wichtig: In Outlook wird zurückgegeben, OfficeOnline wenn ein Add-Is in Outlook im Web oder in einem neuen Outlook unter Windows ausgeführt wird.
Beispiele
const contextInfo = Office.context.diagnostics;
console.log("Platform: " + contextInfo.platform);
version
Ruft die Version von Office ab, auf der das Add-In ausgeführt wird.
version: string;
Eigenschaftswert
string
Hinweise
In Office unter Windows verwendet der von der version -Eigenschaft zurückgegebene Wert das Format 16.0.<build>.<revision>. Um eine Version, die als Version xxxx (Build xxxxx.xxxxx) angezeigt wird, mit dem version Wert zu vergleichen, verwenden Sie die vollständige Buildnummer (<Build.<>revision>). Verwenden Sie beispielsweise in Version 2603 (Build 19822.20000) zum Vergleich 19822.20000.
Beispiele
// Checks whether the Office on Windows version meets a feature's minimum requirements.
const clientVersion = Office.context.diagnostics.version;
// In Office on Windows, the version property is in the format "16.0.<build>.<revision>".
// In this example, Version 2603 (Build 19822.20000) is the minimum version required for the feature.
// 19822 is the build number and 20000 is the revision number.
const minBuildRevision = "19822.20000";
const [, , clientBuild, clientRevision] = clientVersion.split(".");
const [minBuild, minRevision] = minBuildRevision.split(".");
const clientBuildNumber = parseInt(clientBuild, 10);
const clientRevisionNumber = parseInt(clientRevision, 10);
const minBuildNumber = parseInt(minBuild, 10);
const minRevisionNumber = parseInt(minRevision, 10);
if (
clientBuildNumber > minBuildNumber ||
(clientBuildNumber === minBuildNumber && clientRevisionNumber >= minRevisionNumber)
) {
console.log("Office version meets the minimum requirements.");
// Implement the feature-specific actions here.
} else {
console.log("Office version doesn't meet the minimum requirements.");
}