Lire en anglais

Partager via

context (Mailbox requirement set 1.6)

  • Article

Office.context

Office.context fournit des interfaces partagées utilisées par les compléments dans toutes les applications Office. Cette liste documente uniquement les interfaces utilisées par les compléments Outlook. Pour obtenir la liste complète de l’espace de noms Office.context, consultez la référence Office.context dans l’API commune.

Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1.1
Mode Outlook applicable Rédaction ou lecture

Propriétés

Propriété Modes Type de retour Minimum
Ensemble de conditions requises
contentLanguage Composition
Lecture		 String 1.1
Diagnostics Composition
Lecture		 ContextInformation 1,5
displayLanguage Composition
Lecture		 String 1.1
Hôte Composition
Lecture		 HostType 1,5
mailbox Composition
Lecture		 Boîte aux lettres 1.1
Plate-forme Composition
Lecture		 PlatformType 1,5
Exigences Composition
Lecture		 RequirementSetSupport 1.1
roamingSettings Composition
Lecture		 RoamingSettings 1.1
ui Composition
Lecture		 UI 1.1

Détails de la propriété

contentLanguage : chaîne

Obtient les paramètres régionaux (langue) spécifiés par l’utilisateur pour la modification de l’élément.

La contentLanguage valeur reflète le paramètre Langue d’édition actuel spécifié avec La langue des options > de fichier > dans l’application cliente Office.

Type
  • String
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1.1
Mode Outlook applicable Rédaction ou lecture
Exemple
JavaScript 
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

Obtient des informations sur l’environnement dans lequel le complément s’exécute.

Notes

Pour tous les ensembles de conditions requises de boîte aux lettres, vous pouvez également utiliser la propriété Office.context.mailbox.diagnostics pour obtenir des informations similaires.

Type
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1,5
Mode Outlook applicable Rédaction ou lecture
Exemple
JavaScript 
const contextInfo = Office.context.diagnostics;
console.log("Office application: " + contextInfo.host);
console.log("Office version: " + contextInfo.version);
console.log("Platform: " + contextInfo.platform);

displayLanguage : Chaîne

Obtient les paramètres régionaux (langue) au format de balise de langue RFC 1766 spécifié par l’utilisateur pour l’interface utilisateur de l’application cliente Office.

La displayLanguage valeur reflète le paramètre Langue d’affichage actuel spécifié avec Lalangue desoptions> de fichier> dans l’application cliente Office.

Type
  • String
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1.1
Mode Outlook applicable Rédaction ou lecture
Exemple
JavaScript 
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

Obtient l’application Office qui héberge le complément.

Notes

Vous pouvez également utiliser la propriété Office.context.diagnostics pour obtenir l’hôte. Pour tous les ensembles de conditions requises de boîte aux lettres, vous pouvez également utiliser la propriété Office.context.mailbox.diagnostics pour obtenir des informations similaires.

Type
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1,5
Mode Outlook applicable Rédaction ou lecture
Exemple
JavaScript 
console.log(JSON.stringify(Office.context.host));

platform: PlatformType

Fournit la plateforme sur laquelle le complément s’exécute.

Notes

Vous pouvez également utiliser la propriété Office.context.diagnostics pour obtenir la plateforme. Pour tous les ensembles de conditions requises de boîte aux lettres, vous pouvez également utiliser la propriété Office.context.mailbox.diagnostics pour obtenir des informations similaires.

Type
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1,5
Mode Outlook applicable Rédaction ou lecture
Exemple
JavaScript 
console.log(JSON.stringify(Office.context.platform));

configuration requise : RequirementsSetSupport

Fournit une méthode pour déterminer quels ensembles de conditions requises sont pris en charge sur l’application et la plateforme actuelles.

Type
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1.1
Mode Outlook applicable Rédaction ou lecture
Exemple
JavaScript 
console.log(JSON.stringify(Office.context.requirements.isSetSupported("mailbox", "1.1")));

roamingSettings : RoamingSettings

Obtient un objet qui représente les paramètres personnalisés ou l’état d’un complément de messagerie enregistrés dans la boîte aux lettres d’un utilisateur.

L’objet RoamingSettings vous permet de stocker et d’accéder aux données d’un complément de messagerie stocké dans la boîte aux lettres d’un utilisateur, de sorte qu’elles soient disponibles pour ce complément lorsqu’il s’exécute à partir de n’importe quel client Outlook utilisé pour accéder à cette boîte aux lettres.

Type
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1.1
Niveau d’autorisation minimal Restreint
Mode Outlook applicable Rédaction ou lecture

ui : interface utilisateur

Fournit des objets et des méthodes que vous pouvez utiliser pour créer et manipuler des composants d’interface utilisateur, tels que des boîtes de dialogue, dans vos compléments Office.

Type
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1.1
Mode Outlook applicable Rédaction ou lecture