Office.ContextInformation interface

Proporciona información sobre el entorno en el que se ejecuta el complemento.

Comentarios

Importante: En Outlook, este objeto está disponible a partir del conjunto de requisitos de buzón 1.5. Para todos los conjuntos de requisitos de buzón, puede usar la propiedad Office.context.mailbox.diagnostics para obtener información similar.

Usada por

Propiedades

host

Obtiene la aplicación de Office en la que se ejecuta el complemento.

platform

Obtiene la plataforma en la que se ejecuta el complemento.

version

Obtiene la versión de Office en la que se ejecuta el complemento.

Detalles de las propiedades

host

Obtiene la aplicación de Office en la que se ejecuta el complemento.

host: Office.HostType;

Valor de propiedad

Ejemplos

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

platform

Obtiene la plataforma en la que se ejecuta el complemento.

platform: Office.PlatformType;

Valor de propiedad

Comentarios

Importante: En Outlook, OfficeOnline se devuelve si un complemento se ejecuta en Outlook en la Web o en outlook nuevo en Windows.

Ejemplos

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

version

Obtiene la versión de Office en la que se ejecuta el complemento.

version: string;

Valor de propiedad

string

Comentarios

En Office en Windows, el valor devuelto por la version propiedad usa el formato 16.0.<compilación.<>revisión>. Para comparar una versión que se muestra como Versión xxxx (Compilación xxxxx.xxxxx) con el version valor , use el número de compilación completo (<compilación).<>revisión>). Por ejemplo, en la versión 2603 (compilación 19822.20000), use 19822.20000 para la comparación.

Ejemplos

// 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.");
}