context (メールボックス要件セット 1.3)

[アーティクル]
11/08/2023

Office.context

Office.context は、すべての Office アプリでアドインによって使用される共有インターフェイスを提供します。この一覧には、Outlook アドインで使用されるインターフェイスのみが記載されています。Office.context 名前空間の完全な一覧については、 Common API の Office.context リファレンスを参照してください。

要件

要件	値
メールボックスの最小要件セットのバージョン	1.1
適用可能な Outlook のモード	新規作成または閲覧

プロパティ

プロパティ	モード	戻り値の種類	最小値要件セット
contentLanguage	作成読み取り	文字列	1.1
displayLanguage	作成読み取り	文字列	1.1
mailbox	作成読み取り	メールボックス	1.1
要件	作成読み取り	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;
}

displayLanguage: 文字列

Office クライアントアプリケーションの UI に対してユーザーによって指定された RFC 1766 言語タグ形式のロケール (言語) を取得します。

この値は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;
}

requirements: RequirementsSetSupport

現在のアプリケーションとプラットフォームでサポートされている要件セットを決定するためのメソッドを提供します。

型

RequirementSetSupport

要件

要件	値
メールボックスの最小要件セットのバージョン	1.1
適用可能な Outlook のモード	新規作成または閲覧

例

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

roamingSettings: RoamingSettings

ユーザーのメールボックスに保存されている、メールアドインのカスタム設定や状態を表すオブジェクトを取得します。

RoamingSettingsオブジェクトを使用すると、ユーザーのメールボックスに格納されているメールアドインのデータを格納およびアクセスできるため、そのメールボックスへのアクセスに使用される Outlook クライアントから実行されている場合に、そのアドインで使用できます。

型

RoamingSettings

要件

要件	値
メールボックスの最小要件セットのバージョン	1.1
最小限のアクセス許可レベル	制限
適用可能な Outlook のモード	新規作成または閲覧

ui: UI

Office アドインで、ダイアログボックスなどの UI コンポーネントを作成および操作するために使用できるオブジェクトとメソッドを提供します。

型

要件

要件	値
メールボックスの最小要件セットのバージョン	1.1
適用可能な Outlook のモード	新規作成または閲覧

Share via