context (Mailbox 要求集 1.6)

项目
10/23/2024

Office.context

Office.context 提供所有 Office 应用中的加载项使用的共享接口。此列表仅记录 Outlook 加载项使用的那些接口。有关 Office.context 命名空间的完整列表，请参阅通用 API 中的 Office.context 参考。

要求

要求	值
最低版本的邮箱要求集	1.1
适用的 Outlook 模式	撰写或阅读

属性

属性	模式	返回类型	最小值要求集
contentLanguage	撰写读取	String	1.1
诊断	撰写读取	ContextInformation	1.5
displayLanguage	撰写读取	String	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;
}

diagnostics： ContextInformation

获取有关运行加载项的环境的信息。

注意

对于所有邮箱要求集，还可以使用 Office.context.mailbox.diagnostics 属性获取类似信息。

类型

ContextInformation

要求

要求	值
最低版本的邮箱要求集	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

获取用户为 Office 客户端应用程序的 UI 指定的区域设置 (语言) RFC 1766 Language 标记格式。

该值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 属性获取类似信息。

类型

HostType

要求

要求	值
最低版本的邮箱要求集	1.5
适用的 Outlook 模式	撰写或阅读

示例

console.log(JSON.stringify(Office.context.host));

平台： PlatformType

提供运行加载项的平台。

注意

或者，可以使用 Office.context.diagnostics 属性获取平台。对于所有邮箱要求集，还可以使用 Office.context.mailbox.diagnostics 属性获取类似信息。

类型

PlatformType

要求

要求	值
最低版本的邮箱要求集	1.5
适用的 Outlook 模式	撰写或阅读

示例

console.log(JSON.stringify(Office.context.platform));

要求： RequirementSetSupport

提供用于确定当前应用程序和平台支持哪些要求集的方法。

类型

RequirementSetSupport

要求

要求	值
最低版本的邮箱要求集	1.1
适用的 Outlook 模式	撰写或阅读

示例

console.log(JSON.stringify(Office.context.requirements.isSetSupported("mailbox", "1.1")));

roamingSettings： RoamingSettings

获取一个对象，它表示保存到用户邮箱的邮件外接程序的自定义设置或状态。

对象 RoamingSettings 允许您存储和访问存储在用户邮箱中的邮件加载项的数据，以便从用于访问该邮箱的任何 Outlook 客户端运行时，该加载项可用于该加载项。

类型

RoamingSettings

Requirements

要求	值
最低版本的邮箱要求集	1.1
最低权限级别	限制
适用的 Outlook 模式	撰写或阅读

ui： UI

提供可用于在 Office 外接程序中创建和操作 UI 组件（如对话框）的对象和方法。

类型

要求

要求	值
最低版本的邮箱要求集	1.1
适用的 Outlook 模式	撰写或阅读

通过