office package

Classes

Office.TableData	Représente les données d’une table ou d’une Office.TableBinding.
OfficeExtension.ClientObject	Objet proxy abstrait qui représente un objet dans un document Office. Vous créez des objets proxy à partir du contexte (ou d’autres objets proxy), ajoutez des commandes à une file d’attente pour agir sur l’objet, puis synchronisez l’état de l’objet proxy avec le document en appelant context.sync().
OfficeExtension.ClientRequestContext	Objet RequestContext abstrait qui facilite l’envoi de demandes à l’application Office. Les Excel.run méthodes et Word.run fournissent un contexte de requête.
OfficeExtension.ClientResult	Contient les résultats des méthodes qui renvoient des types primitifs. La propriété value de l’objet est récupérée à partir du document après context.sync() avoir été invoquée.
OfficeExtension.EmbeddedSession	Représente une session de diagramme Visio incorporé dans une page SharePoint. Pour plus d’informations, voir Présentation de l’API JavaScript de Visio.
OfficeExtension.Error	Objet d’erreur renvoyé par context.sync(), si une promesse est rejetée en raison d’une erreur lors du traitement de la demande.
OfficeExtension.ErrorCodes	Représente le code d’erreur qui peut être retourné par OfficeExtension.Error.code. Pour en savoir plus sur les codes d’erreur, consultez Codes d’erreur de l’API commune d’Office.
OfficeExtension.EventHandlerResult	Active la suppression d’un gestionnaire d’événements. Retourné par la EventHandlers.add méthode. Remarque : le même objet RequestContext dans lequel le gestionnaire a été ajouté doit être utilisé lors de la suppression du gestionnaire. Vous trouverez plus d’informations dans Supprimer un gestionnaire d’événements.
OfficeExtension.EventHandlers
OfficeExtension.TrackedObjects	Collection d’objets suivis, contenus dans un contexte de requête. Pour plus d’informations , consultez context.trackedObjects .

Interfaces

Office.Actions	Gère les actions et les raccourcis clavier.
Office.AddBindingFromNamedItemOptions	Fournit des options pour configurer la liaison créée.
Office.AddBindingFromPromptOptions	Fournit des options pour configurer l’invite et identifier la liaison créée.
Office.AddBindingFromSelectionOptions	Fournit des options permettant d’identifier la liaison créée.
Office.Addin	Représente une fonctionnalité de niveau complément pour le fonctionnement ou la configuration de différents aspects du complément.
Office.AddinCommands.Event	L’objet Event est transmis en tant que paramètre aux fonctions de complément invoquées par les boutons de commande de fonction. L’objet permet au complément d’identifier le bouton sur lequel l’utilisateur a cliqué et de signaler à l’application Office qu’il a terminé son traitement.
Office.AddinCommands.EventCompletedOptions	Spécifie le comportement d’un complément à l’envoi, d’un complément de fournisseur de réunions en ligne ou d’un complément mobile de journalisation des notes lorsqu’il termine le traitement d’un événement dans Outlook.
Office.AddinCommands.Source	Encapsule les données sources pour les événements de complément.
Office.AsyncContextOptions	Fournit une option permettant de conserver les données de contexte de tout type, inchangées, pour une utilisation dans un rappel.
Office.AsyncResult	Objet qui encapsule le résultat d’une requête asynchrone, y compris les informations d’état et d’erreur quand la demande a échoué. Lorsque la fonction que vous passez au callback paramètre d’une méthode « Async » s’exécute, elle reçoit un objet AsyncResult auquel vous pouvez accéder à partir du seul paramètre de la callback fonction.
Office.Auth	L’espace de noms Office Auth, Office.auth, fournit à l’application cliente Office des méthodes permettant d’obtenir des jetons d’accès à l’application web du complément. Indirectement, ceci active également le complément pour accéder aux données de Microsoft Graph de l’utilisateur sans que l’utilisateur ne doive se connecter une deuxième fois.
Office.AuthContext	Représente les informations utilisateur qui peuvent être transmises à la bibliothèque d’authentification Microsoft pour JavaScript (MSAL.js).
Office.AuthOptions	Fournit des options pour l’expérience utilisateur lorsqu’Office obtient un jeton d’accès au complément à partir d’AAD v. 2.0 avec la getAccessToken méthode.
Office.BeforeDocumentCloseNotification	Représente une boîte de dialogue de notification modale qui peut s’afficher lorsque l’utilisateur tente de fermer un document. Le document ne se ferme pas tant que l’utilisateur n’a pas répondu. La boîte de dialogue de notification permet à l’utilisateur de confirmer la demande de fermeture du document ou d’annuler la demande de fermeture du document. Cette API est uniquement prise en charge dans Excel.
Office.Binding	Représente une liaison à une section du document. L’objet Binding expose les fonctionnalités de toutes les liaisons, quel que soit leur type. L’objet Binding n’est jamais appelé directement. Il s’agit de la classe parent abstraite des objets qui représentent chaque type de liaison : Office.MatrixBinding, Office.TableBinding ou Office.TextBinding. Ces trois objets héritent des méthodes getDataAsync et setDataAsync de l’objet Binding qui vous permettent d’interagir avec les données de la liaison. Ils héritent également des propriétés ID et type pour interroger ces valeurs de propriété. En outre, les objets MatrixBinding et TableBinding exposent des méthodes supplémentaires pour les fonctionnalités relatives aux matrices et aux tableaux, par exemple le dénombrement des lignes et des colonnes.
Office.BindingDataChangedEventArgs	Fournit des informations sur la liaison qui a déclenché l’événement DataChanged.
Office.Bindings	Représente les liaisons du complément au sein du document.
Office.BindingSelectionChangedEventArgs	Fournit des informations sur la liaison qui a déclenché l’événement SelectionChanged.
Office.Context	Représente l’environnement d’exécution du complément et permet d’accéder à des objets clés de l’API. Le contexte actuel existe en tant que propriété d’Office. On y accède à l’aide Office.contextde .
Office.ContextInformation	Fournit des informations sur l’environnement dans lequel le complément est en cours d’exécution.
Office.ContextMenu	Fournit des options pour gérer l’état du menu contextuel Office. Pour plus d’informations, consultez Modifier la disponibilité des commandes de complément.
Office.ContextMenuControl	Représente un contrôle de menu contextuel individuel et son état. Pour plus d’informations, consultez Modifier la disponibilité des commandes de complément.
Office.ContextMenuUpdaterData	Représente les modifications apportées au menu contextuel. Pour plus d’informations, consultez Modifier la disponibilité des commandes de complément.
Office.Control	Représente un contrôle ou une commande individuelle et l’état qu’il doit avoir.
Office.CustomXmlNode	Représente un nœud XML dans une arborescence au sein d’un document.
Office.CustomXmlPart	Représente un seul CustomXMLPart dans une collection Office.CustomXmlParts .
Office.CustomXmlParts	Représente une collection d’objets CustomXmlPart.
Office.CustomXmlPrefixMappings	Représente une collection d’objets CustomXmlPart.
Office.DevicePermission	Fournit des méthodes permettant à un complément de demander à un utilisateur l’autorisation d’accéder aux fonctionnalités de son appareil. Les fonctionnalités de l’appareil d’un utilisateur incluent son appareil photo, sa géolocalisation et son microphone.
Office.Dialog	L’objet qui est renvoyé quand UI.displayDialogAsync est appelé. Il expose les méthodes d’inscription des gestionnaires d’événements et de fermeture de la boîte de dialogue.
Office.DialogMessageOptions	Fournit des options d’envoi de messages, dans les deux sens, entre un dialogue et son parent.
Office.DialogOptions	Fournit des options pour l’affichage d’une boîte de dialogue.
Office.DialogParentMessageReceivedEventArgs	Fournit des informations sur le message de la page parente qui a déclenché l’événement DialogParentMessageReceived . Pour ajouter un gestionnaire d’événements pour l’événement DialogParentMessageReceived , utilisez la addHandlerAsync méthode de l’objet Office.UI .
Office.Document	Une classe abstraite qui représente le document avec lequel interagit le complément.
Office.DocumentSelectionChangedEventArgs	Fournit des informations sur le document qui a déclenché l’événement SelectionChanged.
Office.Error	Fournit des informations spécifiques sur une erreur qui s’est produite pendant une opération de données asynchrone.
Office.ExtensionLifeCycle	Fournit des options permettant de gérer l’interface utilisateur d’un complément Office pendant son exécution.
Office.File	Représente le fichier du document associé à un complément Office.
Office.FileProperties
Office.GetBindingDataOptions	Fournit des options pour obtenir les données dans une liaison.
Office.GetFileOptions	Fournit des options pour définir la taille des tranches qui diviseront le document.
Office.GetSelectedDataOptions	Fournit des options pour personnaliser les données renvoyées et leur mise en forme.
Office.GoToByIdOptions	Fournit des options permettant de sélectionner ou non l’emplacement vers lequel accéder.
Office.Group	Représente un groupe de contrôles sur un onglet de ruban. Ensemble de conditions requises : RibbonApi 1.1
Office.IPromiseConstructor
Office.MatrixBinding	Représente une liaison à deux dimensions de lignes et de colonnes.
Office.NodeDeletedEventArgs	Fournit des informations sur le nœud supprimé qui a déclenché l’événement nodeDeleted.
Office.NodeInsertedEventArgs	Fournit des informations sur le nœud inséré qui a déclenché l’événement nodeInserted.
Office.NodeReplacedEventArgs	Fournit des informations sur le nœud remplacé qui a déclenché l’événement nodeReplaced.
Office.OfficeTheme	Permet d’accéder aux propriétés pour les couleurs du thème Office. L’utilisation des couleurs du thème Office vous permet de coordonner le modèle de couleurs de votre complément avec le thème Office actuel sélectionné par l’utilisateur. L’utilisateur définit un thème dans une application Office via lecomptede fichier> ou lethème Office decompte> Office. Le thème sélectionné est ensuite appliqué à toutes les applications Office. Les couleurs du thème Office s’utilisent avec les compléments de messagerie et du volet Office. Pour plus d’informations sur les thèmes Office, voir Modifier l’apparence de Microsoft 365.
Office.OnReadyOptions	Fournit des options liées à l’événement onReady .
Office.RangeCoordinates	Spécifie une cellule, une ligne ou une colonne par son numéro de ligne et/ou de colonne en base zéro. Exemple : {row: 3, column: 4} spécifie la cellule de la troisième ligne (base zéro) de la 4e colonne (base zéro).
Office.RangeFormatConfiguration	Spécifie une plage et sa mise en forme.
Office.RemoveHandlerOptions	Fournit des options pour déterminer quel(s) gestionnaire(s) d’événements sont supprimés.
Office.RequirementSetSupport	Fournit des informations sur les ensembles de conditions requises pris en charge dans l’environnement actuel.
Office.Ribbon	Interface qui contient toutes les fonctionnalités fournies pour gérer l’état du ruban Office.
Office.RibbonUpdaterData	Spécifie les modifications apportées au ruban, telles que le status activé ou désactivé d’un bouton.
Office.SaveSettingsOptions	Fournit des options pour enregistrer les paramètres.
Office.SetBindingDataOptions	Fournit des options de définition des données dans une liaison.
Office.SetSelectedDataOptions	Fournit des options d’insertion de données dans la sélection.
Office.Settings	Représente des paramètres personnalisés pour un complément de contenu ou de volet des tâches qui sont stockés dans le document hôte comme paires nom/valeur.
Office.SettingsChangedEventArgs	Fournit des informations sur les paramètres qui ont déclenché l’événement settingsChanged. Pour ajouter un gestionnaire d’événements pour l’événement settingsChanged, utilisez la méthode addHandlerAsync de l’objet Office.Settings . L’événement settingsChanged se déclenche uniquement lorsque le script de votre complément appelle la méthode Settings.saveAsync pour conserver la copie en mémoire des paramètres dans le fichier document. L’événement settingsChanged ne se déclenche pas lors de l’appel de la méthode Settings.set ou Settings.remove. L’événement settingsChanged a été conçu pour vous permettre de gérer les conflits potentiels lorsque deux utilisateurs ou plus tentent d’enregistrer les paramètres en même temps lorsque votre complément est utilisé dans un document partagé (co-créé). Important : le code de votre complément peut inscrire un gestionnaire pour l’événement settingsChanged lorsque le complément s’exécute avec un client Excel, mais l’événement ne se déclenche que lorsque le complément est chargé avec une feuille de calcul qui est ouverte dans Excel sur le Web et que plusieurs utilisateurs modifient la feuille de calcul (co-création). Par conséquent, l’événement settingsChanged est effectivement pris en charge uniquement dans Excel sur le Web dans les scénarios de co-création.
Office.Slice	Représente une section d’un fichier de document. L’objet Slice est accessible avec la File.getSliceAsync méthode.
Office.Slide	Représente une seule diapositive dans une présentation PowerPoint. Cette interface est utilisée dans le cadre de l’objet Office.SlideRange renvoyé par Office.Document.getSelectedDataAsync lorsqu’il est appelé avec Office.CoercionType.SlideRange.
Office.SlideRange	Représente les diapositives sélectionnées dans une présentation PowerPoint. Cet objet est renvoyé lors de l’appel de Office.Document.getSelectedDataAsync avec Office.CoercionType.SlideRange dans PowerPoint.
Office.Tab	Représente un onglet individuel et l’état qu’il devrait avoir. Pour obtenir des exemples de code, consultez les rubriques Modifier la disponibilité des commandes de complément et Créer des onglets contextuels personnalisés.
Office.TableBinding	Représente une liaison à deux dimensions de lignes et de colonnes, avec éventuellement des en-têtes.
Office.TaskPane	Fournit des méthodes pour gérer le volet Office d’un complément.
Office.TextBinding	Représente une sélection de texte lié dans le document. L’objet TextBinding hérite de la propriété, de la propriété type, de la méthode getDataAsync et de la id méthode setDataAsync de l’objet Office.Binding . Il n’implémente aucune propriété ou méthode supplémentaire.
Office.UI	Fournit des objets et des méthodes pour créer et manipuler des composants d’interface utilisateur, tels que des boîtes de dialogue, dans vos compléments Office. Pour obtenir des instructions sur la manière de configurer les boîtes de dialogue, voir Utiliser l’API Dialogue dans vos compléments Office.
Office.Urls	Fournit les URL des environnements d’exécution utilisés par un complément.
Office.VisibilityModeChangedMessage	Message utilisé lors de l’appel onVisibilityModeChanged .
OfficeExtension.DebugInfo	Fournit des informations sur une erreur.
OfficeExtension.EmbeddedOptions	Spécifie les options d’une session d’un diagramme Visio incorporé dans une page SharePoint. Appelé par le constructeur de EmbeddedSession. Pour plus d’informations, voir Présentation de l’API JavaScript de Visio.
OfficeExtension.EventInfo	Utilisé par Office pour construire des gestionnaires d’événements. N’appelez pas votre code.
OfficeExtension.LoadOption	Spécifie les propriétés d’un objet qui doit être chargé. Ce chargement se produit lorsque la méthode sync() est exécutée. Cette opération synchronise les états entre les objets Office et les objets proxy JavaScript correspondants.
OfficeExtension.RequestContextDebugInfo	Contient des informations de débogage sur le contexte de la demande.
OfficeExtension.RequestUrlAndHeaderInfo	URL et en-têtes de la requête
OfficeExtension.RunOptions	Options supplémentaires passées dans {Host}.run(...).
OfficeExtension.UpdateOptions	Fournit une option permettant de supprimer une erreur lorsque l’objet utilisé pour définir plusieurs propriétés tente de définir des propriétés en lecture seule.

Alias de type

OfficeExtension.IPromise

Énumérations

Office.ActiveView	Spécifie l’état de l’affichage dynamique du document, par exemple, si l’utilisateur peut modifier le document.
Office.AsyncResultStatus	Spécifie le résultat d’un appel asynchrone.
Office.BindingType	Spécifie le type de l’objet de liaison qui doit être retourné.
Office.CoercionType	Indique comment forcer le type des données retournées ou définies par la méthode appelée.
Office.CustomXMLNodeType	Spécifie le type du nœud XML.
Office.DevicePermissionType	Spécifie la capacité de l’appareil à laquelle un complément demande l’accès.
Office.DocumentMode	Indique si le document de l’application associée est en lecture seule ou en lecture/écriture.
Office.EventType	Spécifie le genre de l’événement qui a été déclenché. Renvoyé par la type propriété d’un *EventArgs objet. Les compléments pour Project prennent en charge les types d’événements Office.EventType.ResourceSelectionChanged, Office.EventType.TaskSelectionChangedOffice.EventType.ViewSelectionChanged et . Seuls les compléments de volet Office pour Outlook prennent en charge les types d’événements définis par l’API de boîte aux lettres.
Office.FileType	Spécifie le format de retour du document.
Office.FilterType	Indique si le filtrage à partir de l’application Office est appliqué lorsque les données sont récupérées.
Office.GoToType	Spécifie le type d’emplacement ou d’objet auquel accéder
Office.HostType	Spécifie l’application Office dans laquelle le complément est exécuté.
Office.Index	Spécifie la diapositive PowerPoint relative.
Office.InitializationReason	Indique si le complément vient d’être inséré ou s’il était déjà contenu dans le document.
Office.PlatformType	Spécifie le système d’exploitation ou une autre plateforme sur laquelle l’application Office s’exécute.
Office.ProjectProjectFields	Spécifie les champs de projet disponibles en tant que paramètre pour la méthode Document.getProjectFieldAsync.
Office.ProjectResourceFields	Spécifie les champs de ressource disponibles en tant que paramètre pour la méthode Document.getResourceFieldAsync.
Office.ProjectTaskFields	Spécifie les champs de tâche disponibles en tant que paramètre pour la méthode Document.getTaskFieldAsync.
Office.ProjectViewTypes	Spécifie les types d’affichages que la méthode Document.getSelectedViewAsync peut reconnaître.
Office.SelectionMode	Indique s’il faut sélectionner (mettre en surbrillance) l’emplacement vers lequel accéder (lors de l’utilisation de la méthode Document.goToByIdAsync).
Office.StartupBehavior	Cet article fournit des options permettant de déterminer le comportement de démarrage du complément au prochain démarrage.
Office.Table	Spécifie les valeurs énumérées pour la cells propriété dans le paramètre cellFormat des méthodes de mise en forme de table.
Office.ThemeId	Spécifie le thème Office actuellement sélectionné. Pour plus d’informations sur les thèmes Office, voir Modifier l’apparence de Microsoft 365.
Office.ValueFormat	Spécifie si les valeurs (telles que les nombres et les dates) retournées par la méthode appelée sont retournées avec leur mise en forme appliquée.
Office.VisibilityMode	Mode de visibilité du complément.

Functions

Office.initialize(reason)	Se produit quand l’environnement d’exécution est chargé et que le complément est prêt à interagir avec l’application et le document hébergé. Le paramètre reason de la fonction d’écouteur d’événement initialize retourne une InitializationReason valeur d’énumération qui spécifie comment l’initialisation s’est produite. Un complément du volet Office ou de contenu peut être initialisé de deux façons : L’utilisateur vient de l’insérer à partir de la section Compléments récemment utilisés de la liste déroulante Complément de l’onglet Insertion du ruban dans l’application Office ou à partir de la boîte de dialogue Insérer un complément. L’utilisateur a ouvert un document qui contient déjà le complément. Remarque : le paramètre reason de la fonction d’auditeur d’événement initialize ne retourne InitializationReason une valeur d’énumération que pour le volet Office et les compléments de contenu. Il ne retourne pas de valeur pour les compléments Outlook.
Office.isSetSupported(name, minVersion)	Vérifie si l’ensemble de conditions requises spécifié est pris en charge par l’application Office.
Office.onReady(callback)	Garantit que les API JavaScript Office sont prêtes à être appelées par le complément. Si l’infrastructure n’a pas encore été initialisée, le rappel ou la promesse attend que l’application Office soit prête à accepter les appels d’API. Notez que cette API est destinée à être utilisée à l’intérieur d’un complément Office, mais elle peut également être utilisée en dehors du complément. Dans ce cas, une fois que Office.js détermine qu’il s’exécute en dehors d’une application Office, il appelle le rappel et résout la promesse avec « null » pour l’application et la plateforme.
Office.select(expression, callback)	Renvoie la promesse d’un objet décrit dans l’expression. Le rappel est appelé uniquement si la fonction échoue.
Office.useShortNamespace(useShortNamespace)	Active et désactive l’alias Office pour l’espace de noms complet Microsoft.Office.WebExtension .

Informations relatives à la fonction

Office.initialize(reason)

Se produit quand l’environnement d’exécution est chargé et que le complément est prêt à interagir avec l’application et le document hébergé.

Le paramètre reason de la fonction d’écouteur d’événement initialize retourne une InitializationReason valeur d’énumération qui spécifie comment l’initialisation s’est produite. Un complément du volet Office ou de contenu peut être initialisé de deux façons :

• L’utilisateur vient de l’insérer à partir de la section Compléments récemment utilisés de la liste déroulante Complément de l’onglet Insertion du ruban dans l’application Office ou à partir de la boîte de dialogue Insérer un complément.

• L’utilisateur a ouvert un document qui contient déjà le complément.

Remarque : le paramètre reason de la fonction d’auditeur d’événement initialize ne retourne InitializationReason une valeur d’énumération que pour le volet Office et les compléments de contenu. Il ne retourne pas de valeur pour les compléments Outlook.

export function initialize(reason: InitializationReason): void;

Paramètres

reason

Office.InitializationReason

Indique comment l’application a été initialisée.

Retours

void

Remarques

Détails concernant le support

Pour plus d’informations sur la configuration requise pour les applications Office et les serveurs, voir Configuration requise pour exécuter Compléments Office.

Applications prises en charge, par plateforme

	Office sur le web	Office pour Windows	Office sur Mac	Office sur iPad	Outlook sur les appareils mobiles
Excel	Pris en charge	Pris en charge	Pris en charge	Pris en charge	Non applicable
Outlook	Pris en charge	Pris en charge	Pris en charge	Pris en charge	Pris en charge
PowerPoint	Pris en charge	Pris en charge	Pris en charge	Pris en charge	Non applicable
Projet	Non pris en charge	Pris en charge	Pris en charge	Non pris en charge	Non applicable
Word	Pris en charge	Pris en charge	Pris en charge	Pris en charge	Non applicable

Exemples

// You can use the value of the InitializationEnumeration to implement different logic for
// when the add-in is first inserted versus when it is already part of the document.
// The following example shows some simple logic that uses the value of the reason parameter
// to display how the task pane or content add-in was initialized.
Office.initialize = function (reason) {
    // Checks for the DOM to load using the jQuery ready method.
    $(document).ready(function () {
        // After the DOM is loaded, code specific to the add-in can run.
        // Display initialization reason.
        if (reason === Office.InitializationReason.Inserted) {
            write("The add-in was just inserted.");
        }

        if (reason === Office.InitializationReason.DocumentOpened) {
            write("The add-in is already part of the document.");
        }
    });
}

// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}

Office.isSetSupported(name, minVersion)

Avertissement

Cette API est à présent déconseillée.

This API returns inaccurate values when used on desktop applications. Use Office.context.requirements.isSetSupported instead.

Vérifie si l’ensemble de conditions requises spécifié est pris en charge par l’application Office.

export function isSetSupported(name: string, minVersion?: string): boolean;

Paramètres

name

string

Nom de l’ensemble ; Par exemple, « MatrixBindings ».

minVersion

string

Version minimale requise ; Par exemple, « 1,4 ».

Retours

boolean

Office.onReady(callback)

Garantit que les API JavaScript Office sont prêtes à être appelées par le complément. Si l’infrastructure n’a pas encore été initialisée, le rappel ou la promesse attend que l’application Office soit prête à accepter les appels d’API. Notez que cette API est destinée à être utilisée à l’intérieur d’un complément Office, mais elle peut également être utilisée en dehors du complément. Dans ce cas, une fois que Office.js détermine qu’il s’exécute en dehors d’une application Office, il appelle le rappel et résout la promesse avec « null » pour l’application et la plateforme.

export function onReady(callback?: (info: { host: HostType, platform: PlatformType }) => any): Promise<{ host: HostType, platform: PlatformType }>;

Paramètres

callback

(info: { host: Office.HostType, platform: Office.PlatformType }) => any

Une fonction de rappel optionnelle, qui recevra les informations sur l’application et la plate-forme. Plutôt que d’utiliser un rappel, un complément peut simplement attendre que la promesse retournée par la fonction soit résolue.

Retours

Promise<{ host: Office.HostType, platform: Office.PlatformType }>

Une promesse qui contient les informations sur l’application et la plateforme, une fois l’initialisation terminée.

Exemples

Office.onReady(function(info) {
    if (info.host === Office.HostType.Excel) {
        // Do Excel-specific initialization (for example, make add-in task pane's
        // appearance compatible with Excel "green").
    }
    if (info.platform === Office.PlatformType.PC) {
        // Make minor layout changes in the task pane.
    }
    console.log(`Office.js is now ready in ${info.host} on ${info.platform}`);
});

Office.select(expression, callback)

Renvoie la promesse d’un objet décrit dans l’expression. Le rappel est appelé uniquement si la fonction échoue.

export function select(expression: string, callback?: (result: AsyncResult<any>) => void): Binding;

Paramètres

expression

string

L’objet à récupérer. L’exemple « bindings#BindingName », récupère une promesse de liaison pour une liaison nommée « BindingName »

callback

(result: Office.AsyncResult<any>) => void

Facultatif. Une fonction qui est appelée lorsque le rappel est renvoyé, dont le seul paramètre est de type Office.AsyncResult.

Retours

Office.Binding

Remarques

Détails concernant le support

Pour plus d’informations sur la configuration requise pour les applications Office et les serveurs, voir Configuration requise pour exécuter Compléments Office.

Applications prises en charge, par plateforme

	Office sur le web	Office pour Windows	Office sur iPad
Excel	Pris en charge	Pris en charge	Pris en charge
Word	Non pris en charge	Pris en charge	Pris en charge

Exemples

// The following code example uses the select function to retrieve a binding with the id "cities" from
// the Bindings collection, and then calls the addHandlerAsync method to add an event handler for the
// dataChanged event of the binding.
function addBindingDataChangedEventHandler() {
    Office.select("bindings#cities", function onError(){}).addHandlerAsync(Office.EventType.BindingDataChanged,
    function (eventArgs) {
        doSomethingWithBinding(eventArgs.binding);
    });
}

Office.useShortNamespace(useShortNamespace)

Active et désactive l’alias Office pour l’espace de noms complet Microsoft.Office.WebExtension .

export function useShortNamespace(useShortNamespace: boolean): void;

Paramètres

useShortNamespace

boolean

True pour utiliser l’alias de raccourci ; sinon false pour la désactiver. La valeur par défaut est True.

Retours

void

Remarques

Détails concernant le support

Pour plus d’informations sur la configuration requise pour les applications Office et les serveurs, voir Configuration requise pour exécuter Compléments Office.

Applications prises en charge, par plateforme

	Office sur le web	Office pour Windows	Office sur Mac	Office sur iPad	Outlook sur les appareils mobiles
Excel	Pris en charge	Pris en charge	Non pris en charge	Pris en charge	Non applicable
Outlook	Pris en charge	Pris en charge	Pris en charge	Pris en charge	Pris en charge
PowerPoint	Pris en charge	Pris en charge	Non pris en charge	Pris en charge	Non applicable
Projet	Non pris en charge	Pris en charge	Non pris en charge	Non pris en charge	Non applicable
Word	Pris en charge	Pris en charge	Non pris en charge	Pris en charge	Non applicable

Exemples

function startUsingShortNamespace() {
    if (typeof Office === 'undefined') {
        Microsoft.Office.WebExtension.useShortNamespace(true);
    } else {
        Office.useShortNamespace(true);
    }
    write('Office alias is now ' + typeof Office);
}

function stopUsingShortNamespace() {
    if (typeof Office === 'undefined') {
        Microsoft.Office.WebExtension.useShortNamespace(false);
    } else {
        Office.useShortNamespace(false);
    }
    write('Office alias is now ' + typeof Office);
}

// Function that writes to a div with id='message' on the page.
function write(message) {
    document.getElementById('message').innerText += message;
}