context (набор обязательных для почтового ящика 1.6)
Office.context
Office.context предоставляет общие интерфейсы, которые используются надстройками во всех приложениях Office. В этом списке описаны только те интерфейсы, которые используются надстройками Outlook. Полный список пространства имен Office.context см . в справочнике по Office.context в Common API.
Требования
Требование | Значение |
---|---|
Версия минимального набора требований к почтовому ящику | 1.1 |
Применимый режим Outlook | Создание или чтение |
Свойства
Свойство | Режимы | Тип возвращаемых данных | Minimum набор обязательных требований |
---|---|---|---|
contentLanguage | Создание Чтение |
Строка | 1.1 |
Диагностики | Создание Чтение |
ContextInformation | 1.5 |
displayLanguage | Создание Чтение |
Строка | 1.1 |
Узла | Создание Чтение |
HostType | 1.5 |
mailbox | Создание Чтение |
Mailbox | 1.1 |
Платформы | Создание Чтение |
PlatformType | 1.5 |
Требования | Создание Чтение |
RequirementSetSupport | 1.1 |
roamingSettings | Создание Чтение |
RoamingSettings | 1.1 |
ui | Создание Чтение |
UI | 1.1 |
Сведения о свойстве
contentLanguage: String
Возвращает языковой стандарт (язык), заданный пользователем для редактирования элемента.
Значение contentLanguage
отражает текущий параметр языка редактирования, указанный в разделе Язык параметров > файла > в клиентском приложении Office.
Тип
- String
Требования
Требование | Значение |
---|---|
Версия минимального набора требований к почтовому ящику | 1.1 |
Применимый режим Outlook | Создание или чтение |
Пример
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;
}
диагностика: ContextInformation
Возвращает сведения о среде, в которой выполняется надстройка.
Примечание.
Для всех наборов обязательных для почтовых ящиков можно также использовать свойство Office.context.mailbox.diagnostics для получения аналогичных сведений.
Тип
Требования
Требование | Значение |
---|---|
Минимальная версия набора обязательных элементов для почтового ящика | 1.5 |
Применимый режим Outlook | Создание или чтение |
Пример
const contextInfo = Office.context.diagnostics;
console.log("Office application: " + contextInfo.host);
console.log("Office version: " + contextInfo.version);
console.log("Platform: " + contextInfo.platform);
displayLanguage: String
Возвращает языковой стандарт (язык) в формате тега языка RFC 1766, заданном пользователем для пользовательского интерфейса клиентского приложения Office.
Значение displayLanguage
отражает текущий параметр языка интерфейса, указанный в разделеЯзык параметров>файла> в клиентском приложении Office.
Тип
- String
Требования
Требование | Значение |
---|---|
Версия минимального набора требований к почтовому ящику | 1.1 |
Применимый режим Outlook | Создание или чтение |
Пример
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
Возвращает приложение Office, в котором размещается надстройка.
Примечание.
Кроме того, можно использовать свойство Office.context.diagnostics для получения узла. Для всех наборов обязательных для почтовых ящиков можно также использовать свойство Office.context.mailbox.diagnostics для получения аналогичных сведений.
Тип
Требования
Требование | Значение |
---|---|
Минимальная версия набора обязательных элементов для почтового ящика | 1.5 |
Применимый режим Outlook | Создание или чтение |
Пример
console.log(JSON.stringify(Office.context.host));
platform: PlatformType
Предоставляет платформу, на которой выполняется надстройка.
Примечание.
Кроме того, можно использовать свойство Office.context.diagnostics для получения платформы. Для всех наборов обязательных для почтовых ящиков можно также использовать свойство Office.context.mailbox.diagnostics для получения аналогичных сведений.
Тип
Требования
Требование | Значение |
---|---|
Минимальная версия набора обязательных элементов для почтового ящика | 1.5 |
Применимый режим Outlook | Создание или чтение |
Пример
console.log(JSON.stringify(Office.context.platform));
requirements: RequirementsSetSupport
Предоставляет метод для определения того, какие наборы требований поддерживаются в текущем приложении и платформе.
Тип
Требования
Требование | Значение |
---|---|
Версия минимального набора требований к почтовому ящику | 1.1 |
Применимый режим Outlook | Создание или чтение |
Пример
console.log(JSON.stringify(Office.context.requirements.isSetSupported("mailbox", "1.1")));
roamingSettings: RoamingSettings
Получает объект, представляющий настраиваемые параметры или состояние надстройки почты, сохраненное в почтовом ящике пользователя.
Объект RoamingSettings
позволяет хранить и получать доступ к данным для почтовой надстройки, хранящейся в почтовом ящике пользователя, чтобы она была доступна этой надстройке при ее запуске из любого клиента Outlook, используемого для доступа к этому почтовому ящику.
Тип
Требования
Требование | Значение |
---|---|
Версия минимального набора требований к почтовому ящику | 1.1 |
Минимальный уровень разрешений | Ограничен |
Применимый режим Outlook | Создание или чтение |
ui: пользовательский интерфейс
Предоставляет объекты и методы, которые можно использовать для создания компонентов пользовательского интерфейса, таких как диалоговые окна, и управления ими в надстройках Office.
Тип
Требования
Требование | Значение |
---|---|
Версия минимального набора требований к почтовому ящику | 1.1 |
Применимый режим Outlook | Создание или чтение |
Office Add-ins