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

Office.context

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

要件

プロパティ

プロパティの詳細

認証: Auth

Office アプリケーションがアドインの Web アプリケーションへのアクセス トークンを取得できるようにするメソッドを提供することで、 シングル サインオン (SSO) をサポートします。 これにより、間接的に、サインインしたユーザーの Microsoft Graph データにアドインがアクセスできるようにもなります。ユーザーがもう一度サインインする必要はありません。

種類

• Auth

要件

例

Office.context.auth.getAccessTokenAsync(function(result) {
    if (result.status === "succeeded") {
        var token = result.value;
        // ...
    } else {
        console.log("Error obtaining token", result.error);
    }
});

contentLanguage: String

アイテムを編集するためにユーザーによって指定されたロケール (言語) を取得します。

この値はcontentLanguage、Office クライアント アプリケーションの [ファイル > オプション言語] で指定されている現在の [編集言語] > 設定を反映します。

型

• String

要件

例

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;
}

診断: ContextInformation

アドインが実行されている環境に関する情報を取得します。

種類

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

この値はdisplayLanguage、Office クライアント アプリケーションの [ファイル>オプション言語]> で指定されている現在の表示言語設定を反映します。

型

• String

要件

例

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;
}

host: HostType

アドインをホストしている Office アプリケーションを取得します。

種類

• HostType

要件

例

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

officeTheme: OfficeTheme

Office テーマの色のプロパティにアクセスできるようにします。

種類

• OfficeTheme

要件

例

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

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

platform: PlatformType

アドインが実行されているプラットフォームを提供します。

型

• PlatformType

要件

例

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

requirements: RequirementsSetSupport

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

種類

• RequirementSetSupport

要件

例

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

roamingSettings: RoamingSettings

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

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

種類

• RoamingSettings

要件

sensitivityLabelsCatalog: SensitivityLabelsCatalog

Outlook で秘密度ラベルのカタログの状態をチェックするオブジェクトを取得し、カタログが有効になっている場合は使用可能なすべての秘密度ラベルを取得します。

種類

• SensitivityLabelsCatalog

要件

ui: UI

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

種類

• UI

要件

urls: Urls

アドインのランタイム URL を取得する オブジェクトを提供します。

種類

• Urls

要件

例

const url = Office.context.urls.javascriptRuntimeUrl;
const regex = /=([^&]+)/;
console.log(`First parameter value: ${url.match(regex)[1]}`);

Events

addHandlerAsync と removeHandlerAsync をそれぞれ使用して、次のイベントにサブスクライブおよびサブスクライブ解除できます。