context (conjunto de requisitos de buzón 1.5)
Office.context
Office.context proporciona interfaces compartidas que usan los complementos en todas las aplicaciones de Office. Esta lista solo documenta las interfaces que usan los complementos de Outlook. Para obtener una lista completa del espacio de nombres Office.context, consulte la referencia de Office.context en common API.
Requisitos
Requirement | Valor |
---|---|
Versión del conjunto de requisitos mínimos del buzón | 1.1 |
Modo de Outlook aplicable | Redacción o lectura |
Propiedades
Propiedad | Modos | Tipo devuelto | Mínimo conjunto de requisitos |
---|---|---|---|
contentLanguage | Redacción Lectura |
Cadena | 1.1 |
Diagnóstico | Redacción Lectura |
ContextInformation | 1.5 |
displayLanguage | Redacción Lectura |
Cadena | 1.1 |
Host | Redacción Lectura |
HostType | 1.5 |
mailbox | Redacción Lectura |
Buzón | 1.1 |
Plataforma | Redacción Lectura |
Platform Type | 1.5 |
Requisitos | Redacción Lectura |
RequirementSetSupport | 1.1 |
roamingSettings | Redacción Lectura |
RoamingSettings | 1.1 |
ui | Redacción Lectura |
UI | 1.1 |
Detalles de la propiedad
contentLanguage: String
Obtiene la configuración regional (idioma) especificada por el usuario para editar el elemento.
El contentLanguage
valor refleja la configuración de idioma de edición actual especificada con El lenguaje de opciones > de archivo > en la aplicación cliente de Office.
Tipo
- Cadena
Requisitos
Requirement | Valor |
---|---|
Versión del conjunto de requisitos mínimos del buzón | 1.1 |
Modo de Outlook aplicable | Redacción o lectura |
Ejemplo
function sayHelloWithContentLanguage() {
const myContentLanguage = Office.context.contentLanguage;
switch (myContentLanguage) {
case 'en-US':
write('Hello!');
break;
case 'en-NZ':
write('G\'day mate!');
break;
}
}
// Function that writes to a div with id='message' on the page.
function write(message){
document.getElementById('message').innerText += message;
}
diagnostics: ContextInformation
Obtiene información sobre el entorno en el que se ejecuta el complemento.
Nota:
Para todos los conjuntos de requisitos de buzón, también puede usar la propiedad Office.context.mailbox.diagnostics para obtener información similar.
Tipo
Requisitos
Requirement | Valor |
---|---|
Versión del conjunto de requisitos mínimos del buzón | 1,5 |
Modo de Outlook aplicable | Redacción o lectura |
Ejemplo
const contextInfo = Office.context.diagnostics;
console.log("Office application: " + contextInfo.host);
console.log("Office version: " + contextInfo.version);
console.log("Platform: " + contextInfo.platform);
displayLanguage: String
Obtiene la configuración regional (idioma) en formato de etiqueta de idioma RFC 1766 especificado por el usuario para la interfaz de usuario de la aplicación cliente de Office.
El displayLanguage
valor refleja la configuración de idioma de presentación actual especificada conEl lenguajede opciones> de archivo> en la aplicación cliente de Office.
Tipo
- Cadena
Requisitos
Requirement | Valor |
---|---|
Versión del conjunto de requisitos mínimos del buzón | 1.1 |
Modo de Outlook aplicable | Redacción o lectura |
Ejemplo
function sayHelloWithDisplayLanguage() {
const myDisplayLanguage = Office.context.displayLanguage;
switch (myDisplayLanguage) {
case 'en-US':
write('Hello!');
break;
case 'en-NZ':
write('G\'day mate!');
break;
}
}
// Function that writes to a div with id='message' on the page.
function write(message){
document.getElementById('message').innerText += message;
}
host: HostType
Obtiene la aplicación de Office que hospeda el complemento.
Nota:
Como alternativa, puede usar la propiedad Office.context.diagnostics para obtener el host. Para todos los conjuntos de requisitos de buzón, también puede usar la propiedad Office.context.mailbox.diagnostics para obtener información similar.
Tipo
Requisitos
Requirement | Valor |
---|---|
Versión del conjunto de requisitos mínimos del buzón | 1,5 |
Modo de Outlook aplicable | Redacción o lectura |
Ejemplo
console.log(JSON.stringify(Office.context.host));
platform: PlatformType
Proporciona la plataforma en la que se ejecuta el complemento.
Nota:
Como alternativa, puede usar la propiedad Office.context.diagnostics para obtener la plataforma. Para todos los conjuntos de requisitos de buzón, también puede usar la propiedad Office.context.mailbox.diagnostics para obtener información similar.
Tipo
Requisitos
Requirement | Valor |
---|---|
Versión del conjunto de requisitos mínimos del buzón | 1,5 |
Modo de Outlook aplicable | Redacción o lectura |
Ejemplo
console.log(JSON.stringify(Office.context.platform));
requirements: RequirementSetSupport
Proporciona un método para determinar qué conjuntos de requisitos se admiten en la aplicación y plataforma actuales.
Tipo
Requisitos
Requirement | Valor |
---|---|
Versión del conjunto de requisitos mínimos del buzón | 1.1 |
Modo de Outlook aplicable | Redacción o lectura |
Ejemplo
console.log(JSON.stringify(Office.context.requirements.isSetSupported("mailbox", "1.1")));
roamingSettings: RoamingSettings
Obtiene un objeto que representa la configuración o el estado personalizado de un complemento de correo que se guardó en el buzón de un usuario.
El RoamingSettings
objeto permite almacenar y acceder a los datos de un complemento de correo que se almacena en el buzón de un usuario, de modo que esté disponible para ese complemento cuando se ejecute desde cualquier cliente de Outlook usado para acceder a ese buzón.
Tipo
Requisitos
Requirement | Valor |
---|---|
Versión del conjunto de requisitos mínimos del buzón | 1.1 |
Nivel de permisos mínimo | Restringido |
Modo de Outlook aplicable | Redacción o lectura |
ui: UI
Proporciona objetos y métodos que puede usar para crear y manipular componentes de interfaz de usuario, como cuadros de diálogo, en los complementos de Office.
Tipo
Requisitos
Requirement | Valor |
---|---|
Versión del conjunto de requisitos mínimos del buzón | 1.1 |
Modo de Outlook aplicable | Redacción o lectura |