Office.Context interface

Представляет среду выполнения надстройки и открывает доступ к ключевым объектам API. Текущий контекст существует как свойство Office. К нему можно получить доступ с помощью Office.context.

Комментарии

Хосты: Excel, Outlook, PowerPoint, Project, Word

Свойства

auth

Предоставляет информацию и доступ вошедшему в систему пользователю.

commerceAllowed

Правда, если текущая платформа позволяет надстройку отображать пользовательский интерфейс для продажи или обновления; в противном случае возвращает False.

contentLanguage

Получает указанный пользователем языковой стандарт (язык) для редактирования документа или элемента.

diagnostics

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

displayLanguage

Получает определенный пользователем языковой стандарт (язык) для пользовательского интерфейса ведущего приложения Office.

document

Получает объект, представляющий документ, с которым взаимодействует контентная надстройка или надстройка области задач.

host

Содержит хост приложения Office, в котором запущена надстройка.

Важно. В Outlook это свойство доступно из набора требований 1.5. Для всех наборов требований к почтовым ящикам свойство можно использовать Office.context.diagnostics для получения хоста.

license

Получает сведения о лицензии для установки Office пользователя.

mailbox

Предоставляет доступ к объектной модели надстройки Microsoft Outlook.

officeTheme

Предоставляет доступ к свойствам цветов темы Office.

platform

Предоставляет платформу, на которой запущена надстройка.

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

requirements

Предоставляет метод определения, какие наборы требований поддерживаются на текущем хосте и платформе.

roamingSettings

Получает объект, представляющий настраиваемые параметры или состояние надстройки почты, сохраненное в почтовом ящике пользователя.

Объект позволяет хранить и получать доступ к данным для почтовой надстройки, хранящейся в почтовом ящике пользователя, поэтому она доступна для этой надстройки, когда она запущена из любого клиентского приложения хост-клиента, используемого для доступа к этому почтовому RoamingSettings ящику.

touchEnabled

Указывает, разрешает ли платформа и устройство сенсорное взаимодействие. True, если надстройка работает на сенсорное устройство, например на iPad; false в противном случае.

ui

Предоставляет объекты и методы, которые можно использовать для создания компонентов пользовательского интерфейса, например диалоговых окон, и управления ими.

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

auth

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Предоставляет информацию и доступ вошедшему в систему пользователю.

auth: Auth;

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

commerceAllowed

Правда, если текущая платформа позволяет надстройку отображать пользовательский интерфейс для продажи или обновления; в противном случае возвращает False.

commerceAllowed: boolean;

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

boolean

Комментарии

Хосты: Excel, Word

commerceAllowed поддерживается только в Office на iPad.

App Store для iOS не поддерживает apps с надстройками, которые предоставляют ссылки на дополнительные системы платежей. Однако надстройки Office, работающие в Office на рабочем столе Windows или в браузере, позволяют использовать такие ссылки. Если вы хотите, чтобы пользовательский интерфейс надстройки предоставил ссылку на внешнюю систему оплаты на платформах, не вносимые в iOS, вы можете использовать свойство commerceAllowed для управления при отображите эту ссылку.

contentLanguage

Получает указанный пользователем языковой стандарт (язык) для редактирования документа или элемента.

contentLanguage: string;

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

string

Комментарии

Это contentLanguage значение отражает параметр Язык редактирования, заданный языком параметров файлов > > в хост-приложении Office.

Сведения о поддержке

Заглавная буква Y в следующей матрице указывает на то, что это свойство поддерживается в соответствующем ведущем приложении Office. Пустая ячейка означает, что ведущее приложение Office не поддерживает это перечисление.

Дополнительные сведения о требованиях к хост-приложениям и серверам Office см. в дополнительных сведениях о требованиях к запуску надстройок Office.

Поддерживаемые ведущие приложения по платформе

Office для Windows Office в веб-браузере Office для iPad Outlook на мобильных устройствах Office для Mac
Excel Да Да Да
Outlook Да Да Да Да
PowerPoint Да Да Да
Project Да
Word Да Да Да

Примеры

function sayHelloWithContentLanguage() {
    var 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

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

diagnostics: ContextInformation;

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

Примеры

var contextInfo = Office.context.diagnostics;
console.log("Office application: " + contextInfo.host);
console.log("Office version: " + contextInfo.version);
console.log("Platform: " + contextInfo.platform);

displayLanguage

Получает определенный пользователем языковой стандарт (язык) для пользовательского интерфейса ведущего приложения Office.

displayLanguage: string;

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

string

Комментарии

Возвращенное значение — строка в формате языковых тегов RFC 1766, например en-US.

Это displayLanguage значение отражает текущий параметр Язык отображения, заданный языком параметров файлов > > в хост-приложении Office.

При использовании в Outlook применимыми режимами являются Compose или Read.

Сведения о поддержке

Заглавная буква Y в следующей матрице указывает на то, что это свойство поддерживается в соответствующем ведущем приложении Office. Пустая ячейка означает, что ведущее приложение Office не поддерживает это перечисление.

Дополнительные сведения о требованиях к хост-приложениям и серверам Office см. в дополнительных сведениях о требованиях к запуску надстройок Office.

Поддерживаемые ведущие приложения по платформе

Office для Windows Office в веб-браузере Office для iPad Outlook на мобильных устройствах Office для Mac
Excel Да Да Да Да
Outlook Да Да Да Да
PowerPoint Да Да Да Да
Project Да Да
Word Да Да Да

Примеры

function sayHelloWithDisplayLanguage() {
    var 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; 
}

document

Получает объект, представляющий документ, с которым взаимодействует контентная надстройка или надстройка области задач.

document: Office.Document;

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

Примеры

// Extension initialization code.
var _document;

// The initialize function is required for all add-ins.
Office.initialize = function () {
    // Checks for the DOM to load using the jQuery ready function.
    $(document).ready(function () {
    // After the DOM is loaded, code specific to the add-in can run.
    // Initialize instance variables to access API objects.
    _document = Office.context.document;
    });
}

host

Содержит хост приложения Office, в котором запущена надстройка.

Важно. В Outlook это свойство доступно из набора требований 1.5. Для всех наборов требований к почтовым ящикам свойство можно использовать Office.context.diagnostics для получения хоста.

host: HostType;

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

license

Получает сведения о лицензии для установки Office пользователя.

license: string;

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

string

mailbox

Предоставляет доступ к объектной модели надстройки Microsoft Outlook.

mailbox: Office.Mailbox;

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

Комментарии

Минимальный уровень разрешений: Restricted

Применимый режим Outlook: составить или прочитать

Свойства ключей:

  • diagnostics: Предоставляет диагностические сведения надстройки Outlook.

  • item. Предоставляет методы и свойства для доступа к сообщению или встрече в надстройки Outlook.

  • userProfile. Предоставляет сведения о пользователе в надстройки Outlook.

Примеры

// The following line of code access the item object of the JavaScript API for Office.
var item = Office.context.mailbox.item;

officeTheme

Предоставляет доступ к свойствам цветов темы Office.

officeTheme: OfficeTheme;

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

Примеры

function applyOfficeTheme(){
    // Get office theme colors.
    var bodyBackgroundColor = Office.context.officeTheme.bodyBackgroundColor;
    var bodyForegroundColor = Office.context.officeTheme.bodyForegroundColor;
    var controlBackgroundColor = Office.context.officeTheme.controlBackgroundColor;
    var controlForegroundColor = Office.context.officeTheme.controlForegroundColor;

    // Apply body background color to a CSS class.
    $('.body').css('background-color', bodyBackgroundColor);
}

platform

Предоставляет платформу, на которой запущена надстройка.

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

platform: PlatformType;

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

requirements

Предоставляет метод определения, какие наборы требований поддерживаются на текущем хосте и платформе.

requirements: RequirementSetSupport;

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

roamingSettings

Получает объект, представляющий настраиваемые параметры или состояние надстройки почты, сохраненное в почтовом ящике пользователя.

Объект позволяет хранить и получать доступ к данным для почтовой надстройки, хранящейся в почтовом ящике пользователя, поэтому она доступна для этой надстройки, когда она запущена из любого клиентского приложения хост-клиента, используемого для доступа к этому почтовому RoamingSettings ящику.

roamingSettings: Office.RoamingSettings;

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

Комментарии

Минимальный уровень разрешений: Restricted

Применимый режим Outlook: составить или прочитать

Примеры

// Get the current value of the 'myKey' setting.
var value = Office.context.roamingSettings.get('myKey');
// Update the value of the 'myKey' setting.
Office.context.roamingSettings.set('myKey', 'Hello World!');
// Persist the change.
Office.context.roamingSettings.saveAsync();

touchEnabled

Указывает, разрешает ли платформа и устройство сенсорное взаимодействие. True, если надстройка работает на сенсорное устройство, например на iPad; false в противном случае.

touchEnabled: boolean;

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

boolean

Комментарии

Хосты: Excel, PowerPoint, Word

touchEnabled поддерживается только в Office на iPad.

Используйте свойство touchEnabled, чтобы определить, когда надстройка работает на сенсорном устройстве и при необходимости настроить тип элементов управления, размер и интервалы элементов в пользовательском интерфейсе надстройки для размещения сенсорных взаимодействий.

ui

Предоставляет объекты и методы, которые можно использовать для создания компонентов пользовательского интерфейса, например диалоговых окон, и управления ими.

ui: UI;

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