Freigeben über

context (Anforderungssatz für postfachvorschau)

  • Artikel

Office.context

Office.context stellt freigegebene Schnittstellen bereit, die von Add-Ins in allen Office-Apps verwendet werden. Diese Auflistung dokumentiert nur die Schnittstellen, die von Outlook-Add-Ins verwendet werden. Eine vollständige Auflistung des Office.context-Namespaces finden Sie in der Office.context-Referenz in der allgemeinen API.

Anforderungen
Anforderung Wert
Mindestversion des Postfachanforderungssatzes 1.1
Zutreffender Outlook-Modus Verfassen oder Lesen

Eigenschaften

Eigenschaft Modi Rückgabetyp Minimum
Anforderungssatz
Auth Verfassen
Lesen		 Auth IdentityAPI 1.3
contentLanguage Verfassen
Lesen		 Zeichenfolge 1.1
Diagnose Verfassen
Lesen		 ContextInformation 1.5
displayLanguage Verfassen
Lesen		 Zeichenfolge 1.1
Host Verfassen
Lesen		 HostType 1.5
Postfach Verfassen
Lesen		 Postfach 1.1
officeTheme Verfassen
Lesen		 OfficeTheme 1.14
Plattform Verfassen
Lesen		 PlatformType 1.5
Anforderungen Verfassen
Lesen		 RequirementSetSupport 1.1
roamingSettings Verfassen
Lesen		 RoamingSettings 1.1
sensitivityLabelsCatalog Verfassen SensitivityLabelsCatalog 1.13
UI Verfassen
Lesen		 Benutzeroberfläche 1.1
Urls Verfassen
Lesen		 Urls 1.14

Eigenschaftendetails

auth: Auth

Unterstützt einmaliges Anmelden (Single Sign-On, SSO), indem eine Methode bereitgestellt wird, mit der die Office-Anwendung ein Zugriffstoken für die Webanwendung des Add-Ins abrufen kann. Dadurch kann das Add-In indirekt auch auf die Microsoft Graph-Daten des angemeldeten Benutzers zugreifen, ohne dass sich der Benutzer ein zweites Mal anmelden muss.

Typ
Anforderungen
Anforderung Wert
Mindestversion des Postfachanforderungssatzes Vorschau
Zutreffender Outlook-Modus Verfassen oder Lesen
Beispiel
Office.context.auth.getAccessTokenAsync(function(result) {
    if (result.status === "succeeded") {
        const token = result.value;
        // ...
    } else {
        console.log("Error obtaining token", result.error);
    }
});

contentLanguage: String

Ruft das Gebietsschema (Sprache) ab, das vom Benutzer zum Bearbeiten des Elements angegeben wurde.

Der contentLanguage Wert spiegelt die aktuelle Einstellung für die Bearbeitungssprache wider, die in der Office-Clientanwendung mit Der Sprache für Dateioptionen >> angegeben ist.

Typ
  • String
Anforderungen
Anforderung Wert
Mindestversion des Postfachanforderungssatzes 1.1
Zutreffender Outlook-Modus Verfassen oder Lesen
Beispiel
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;
}

Diagnose: ContextInformation

Ruft Informationen zur Umgebung ab, in der das Add-In ausgeführt wird.

Hinweis

Für alle Postfachanforderungssätze können Sie auch die Office.context.mailbox.Diagnose-Eigenschaft verwenden, um ähnliche Informationen abzurufen.

Typ
Anforderungen
Anforderung Wert
Mindestversion des Postfachanforderungssatzes 1,5
Zutreffender Outlook-Modus Verfassen oder Lesen
Beispiel
const contextInfo = Office.context.diagnostics;
console.log("Office application: " + contextInfo.host);
console.log("Office version: " + contextInfo.version);
console.log("Platform: " + contextInfo.platform);

displayLanguage: String

Ruft das Gebietsschema (Sprache) im RFC 1766-Sprachtagformat ab, das vom Benutzer für die Benutzeroberfläche der Office-Clientanwendung angegeben wird.

Der displayLanguage Wert spiegelt die aktuelle Einstellung für die Anzeigesprache wider, die in der Office-Clientanwendung mit derDateioptionensprache>> angegeben wurde.

Typ
  • String
Anforderungen
Anforderung Wert
Mindestversion des Postfachanforderungssatzes 1.1
Zutreffender Outlook-Modus Verfassen oder Lesen
Beispiel
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

Ruft die Office-Anwendung ab, die das Add-In hosten.

Hinweis

Alternativ können Sie die Eigenschaft Office.context.Diagnose verwenden, um den Host abzurufen. Für alle Postfachanforderungssätze können Sie auch die Office.context.mailbox.Diagnose-Eigenschaft verwenden, um ähnliche Informationen abzurufen.

Typ
Anforderungen
Anforderung Wert
Mindestversion des Postfachanforderungssatzes 1,5
Zutreffender Outlook-Modus Verfassen oder Lesen
Beispiel
console.log(JSON.stringify(Office.context.host));

officeTheme: OfficeTheme

Bietet Zugriff auf die Eigenschaften für Office-Farbdesigns.

Hinweis

Dieses Mitglied wird nur in Outlook unter Windows unterstützt.

Mithilfe von Office-Designfarben können Sie das Farbschema Ihres Add-Ins mit dem aktuellen Office-Design koordinieren, das vom Benutzer mit der Office-Design-Benutzeroberfläche "Datei > Office-Konto > " ausgewählt wurde, die auf alle Office-Clientanwendungen angewendet wird. Using Office theme colors is appropriate for mail and task pane add-ins.

Typ
Eigenschaften
Name Typ Beschreibung
bodyBackgroundColor String Ruft die Hintergrundfarbe des Office-Designkörpers als hexadezimales Farbtriplet ab.
bodyForegroundColor String Ruft die Vordergrundfarbe des Office-Designkörpers als hexadezimales Farbtriplet ab.
controlBackgroundColor String Ruft die Hintergrundfarbe des Office-Designsteuerelements als hexadezimales Farbtriplet ab.
controlForegroundColor String Ruft die Vordergrundfarbe des Office-Designsteuerelements als hexadezimales Farbtriplet ab.
Anforderungen
Anforderung Wert
Mindestversion des Postfachanforderungssatzes Vorschau
Zutreffender Outlook-Modus Verfassen oder Lesen
Beispiel
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

Stellt die Plattform bereit, auf der das Add-In ausgeführt wird.

Hinweis

Alternativ können Sie die Office.context.Diagnose-Eigenschaft verwenden, um die Plattform abzurufen. Für alle Postfachanforderungssätze können Sie auch die Office.context.mailbox.Diagnose-Eigenschaft verwenden, um ähnliche Informationen abzurufen.

Typ
Anforderungen
Anforderung Wert
Mindestversion des Postfachanforderungssatzes 1,5
Zutreffender Outlook-Modus Verfassen oder Lesen
Beispiel
console.log(JSON.stringify(Office.context.platform));

Requirements: RequirementSetSupport

Stellt eine Methode bereit, um zu bestimmen, welche Anforderungssätze in der aktuellen Anwendung und Plattform unterstützt werden.

Typ
Anforderungen
Anforderung Wert
Mindestversion des Postfachanforderungssatzes 1.1
Zutreffender Outlook-Modus Verfassen oder Lesen
Beispiel
console.log(JSON.stringify(Office.context.requirements.isSetSupported("mailbox", "1.1")));

roamingSettings: RoamingSettings

Ruft ein Objekt ab, das die benutzerdefinierten Einstellungen oder den Status eines Mail-Add-Ins im Postfach eines Benutzers darstellt.

Mit RoamingSettings dem -Objekt können Sie Daten für ein E-Mail-Add-In speichern und darauf zugreifen, das im Postfach eines Benutzers gespeichert ist, sodass dieses Add-In verfügbar ist, wenn es von einem beliebigen Outlook-Client aus ausgeführt wird, der für den Zugriff auf dieses Postfach verwendet wird.

Typ
Anforderungen
Anforderung Wert
Mindestversion des Postfachanforderungssatzes 1.1
Mindestberechtigungsstufe Beschränkt
Zutreffender Outlook-Modus Verfassen oder Lesen

sensitivityLabelsCatalog: SensitivityLabelsCatalog

Ruft das -Objekt ab, um die status des Katalogs von Vertraulichkeitsbezeichnungen in Outlook zu überprüfen und alle verfügbaren Vertraulichkeitsbezeichnungen abzurufen, wenn der Katalog aktiviert ist.

Typ
Anforderungen
Anforderung Wert
Mindestversion des Postfachanforderungssatzes 1.13
Mindestberechtigungsstufe Element lesen/schreiben
Zutreffender Outlook-Modus Verfassen

ui: Ui

Stellt Objekte und Methoden bereit, mit denen Sie Benutzeroberflächenkomponenten wie Dialogfelder in Ihren Office-Add-Ins erstellen und bearbeiten können.

Typ
Anforderungen
Anforderung Wert
Mindestversion des Postfachanforderungssatzes 1.1
Zutreffender Outlook-Modus Verfassen oder Lesen

URLs: URLs

Ruft das -Objekt ab, um die Laufzeit-URLs eines Add-Ins abzurufen.

Typ
Anforderungen
Anforderung Wert
Mindestversion des Postfachanforderungssatzes 1.14
Zutreffender Outlook-Modus Verfassen oder Lesen

Ereignisse

Sie können die folgenden Ereignisse mit addHandlerAsync bzw. removeHandlerAsync abonnieren und kündigen.

Document.SelectionChanged -Ereignis Beschreibung Minimum
Anforderungssatz
OfficeThemeChanged Das Office-Design in Outlook wurde geändert. Nur bei der Implementierung des Aufgabenbereichs verfügbar. 1.14