Office.ContextInformation interface

Пакет:
office

Предоставляет сведения о среде, в которой работает надстройка.

Комментарии

Важно! В Outlook этот объект доступен начиная с набора требований к почтовому ящику 1.5. Для всех наборов требований к почтовым ящикам можно использовать свойство Office.context.mailbox.диагностика, чтобы получить аналогичную информацию.

Используется

Свойства

host

Получает приложение Office, в котором выполняется надстройка.
platform

Получает платформу, на которой работает надстройка.
version

Получает версию Office, в которой выполняется надстройка.

Сведения о свойстве

host

Получает приложение Office, в котором выполняется надстройка.

host: Office.HostType;

Значение свойства

Office.HostType

Примеры

const contextInfo = Office.context.diagnostics;
console.log("Office application: " + contextInfo.host);

platform

Получает платформу, на которой работает надстройка.

platform: Office.PlatformType;

Значение свойства

Office.PlatformType

Комментарии

Важно! В Outlook возвращается, OfficeOnline если надстройка работает в Outlook в Интернете или в новом Outlook для Windows.

Примеры

const contextInfo = Office.context.diagnostics;
console.log("Platform: " + contextInfo.platform);

version

Получает версию Office, в которой выполняется надстройка.

version: string;

Значение свойства

string

Комментарии

В Office для Windows значение, возвращаемое свойствомversion, имеет формат 16.0.<сборку.<>Исправление>. Для сравнения версии, отображаемой как Версия xxxx (сборка xxxxx.xxxxx), со значением version используйте полный номер сборки (<сборка.<>редакция>). Например, для версии 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.");
}