Office.ContextInformation interface
アドインが実行されている環境に関する情報を提供します。
注釈
重要: Outlook では、このオブジェクトはメールボックス要件セット 1.5 以降で使用できます。 すべてのメールボックス要件セットについて、Office.context.mailbox.診断 プロパティを使用して同様の情報を取得できます。
使用元
プロパティ
| host | アドインが実行されている Office アプリケーションを取得します。 |
| platform | アドインが実行されているプラットフォームを取得します。 |
| version | アドインが実行されている Office のバージョンを取得します。 |
プロパティの詳細
host
アドインが実行されている Office アプリケーションを取得します。
host: Office.HostType;
プロパティ値
例
const contextInfo = Office.context.diagnostics;
console.log("Office application: " + contextInfo.host);
platform
アドインが実行されているプラットフォームを取得します。
platform: Office.PlatformType;
プロパティ値
注釈
重要: Outlook では、Outlook on the webまたは新しい Outlook on Windows でアドインが実行されている場合、OfficeOnlineが返されます。
例
const contextInfo = Office.context.diagnostics;
console.log("Platform: " + contextInfo.platform);
version
アドインが実行されている Office のバージョンを取得します。
version: string;
プロパティ値
string
注釈
Office on Windows では、 version プロパティによって返される値は 16.0.< 形式を使用します。build>.<リビジョン>。 バージョン xxxx (Build xxxxx.xxxxx) と version 値として表示されるバージョンを比較するには、完全なビルド番号 (<build>.< を使用します。リビジョン>)。 たとえば、バージョン 2603 (ビルド 19822.20000) では、比較に 19822.20000 を使用します。
例
// 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.");
}