office package
Classes
Office.TableData |
Représente les données d’une table ou d’un objet 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 |
OfficeExtension.ClientRequestContext |
Objet RequestContext abstrait qui facilite les demandes adressées à l’application Office. Les |
OfficeExtension.ClientResult |
Contient le résultat des méthodes qui retournent des types primitifs. La propriété value de l’objet est récupérée du document après |
OfficeExtension.EmbeddedSession |
Représente une session d’un diagramme Visio incorporé dans une page SharePoint. Pour plus d’informations, consultez Vue d’ensemble de l’API JavaScript Visio. |
OfficeExtension.Error |
Objet d’erreur retourné par |
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 communs de l’API Office. |
OfficeExtension.EventHandlerResult |
Active la suppression d’un gestionnaire d’événements. Retourné par la Remarque : le même objet RequestContext dans lequel le gestionnaire a été ajouté doit être utilisé lors de la suppression du gestionnaire. Pour plus d’informations, consultez 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 pour identifier la liaison créée. |
Office.Addin |
Représente les fonctionnalités de niveau complément pour l’exploitation ou la configuration de différents aspects du complément. |
Office.AddinCommands.Event |
L’objet |
Office.AddinCommands.EventCompletedOptions |
Spécifie le comportement d’un complément d’envoi dans Outlook lorsqu’il termine le traitement d’un |
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 |
Office.Auth |
L’espace de noms d’authentification Office, |
Office.AuthContext |
Représente les informations utilisateur qui peuvent être passées à 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 |
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 possédées par toutes les liaisons, quel que soit leur type. L’objet Binding n’est jamais appelé directement. Il s’agit de la classe parente 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 d’ID et de 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. Il est accessible à l’aide |
Office.ContextInformation |
Fournit des informations sur l’environnement dans lequel le complément s’exécute. |
Office.Control |
Représente un contrôle ou une commande individuel 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 d’appareil d’un utilisateur incluent sa caméra, sa géolocalisation et son microphone. |
Office.Dialog |
Objet retourné quand |
Office.DialogMessageOptions |
Fournit des options permettant d’envoyer des 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 Pour ajouter un gestionnaire d’événements pour l’événement |
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.File |
Représente le fichier du document associé à un complément Office. |
Office.FileProperties | |
Office.GetBindingDataOptions |
Fournit des options permettant d’obtenir les données dans une liaison. |
Office.GetFileOptions |
Fournit des options pour définir la taille des tranches dans lesquelles le document sera divisé. |
Office.GetSelectedDataOptions |
Fournit des options de personnalisation des données retournées et de leur mise en forme. |
Office.GoToByIdOptions |
Fournit des options permettant de sélectionner ou non l’emplacement auquel vous accédez. |
Office.Group |
Représente un groupe de contrôles sur un onglet du 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 de thème Office vous permet de coordonner le jeu 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 Officedu compte> 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.RangeCoordinates |
Spécifie une cellule, une ligne ou une colonne par sa ligne de base zéro et/ou son numéro de colonne. Exemple : |
Office.RangeFormatConfiguration |
Spécifie une plage et sa mise en forme. |
Office.RemoveHandlerOptions |
Fournit des options pour déterminer le ou les gestionnaires d’événements qui 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 l’état activé ou désactivé d’un bouton. |
Office.SaveSettingsOptions |
Fournit des options d’enregistrement des paramètres. |
Office.SetBindingDataOptions |
Fournit des options pour définir les données dans une liaison. |
Office.SetSelectedDataOptions |
Fournit des options permettant d’insérer des 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 de 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 des 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 n’importe quel client Excel, mais l’événement se déclenche uniquement lorsque le complément est chargé avec une feuille de calcul 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 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 |
Office.Tab |
Représente un onglet individuel et l’état qu’il doit avoir. Pour obtenir des exemples de code, consultez Activer et désactiver les 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.TextBinding |
Représente une sélection de texte lié dans le document. L’objet TextBinding hérite de la propriété, de la |
Office.UI |
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. Pour plus d’informations, consultez « Utiliser l’API de boîte de 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é dans l’appel |
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 |
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 doivent être chargées. Cette charge se produit lorsque la méthode sync() est exécutée. Cela 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 demande |
OfficeExtension.RunOptions |
Options supplémentaires passées dans |
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 fonctionnalité d’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é. Retourné par la Les compléments pour Project prennent en charge les Seuls les compléments du volet Office pour Outlook prennent en charge les types d’événements d’ensemble d’API de boîte aux lettres. |
Office.FileType |
Spécifie le format de retour du document. |
Office.FilterType |
Spécifie 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 s’exécute. |
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 toute 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 de vues que la méthode Document.getSelectedViewAsync peut reconnaître. |
Office.SelectionMode |
Spécifie s’il faut sélectionner (mettre en surbrillance) l’emplacement auquel accéder (lors de l’utilisation de la méthode Document.goToByIdAsync). |
Office.StartupBehavior |
Fournit des options pour déterminer le comportement de démarrage du complément lors du prochain démarrage. |
Office.Table |
Spécifie les valeurs énumérées pour la |
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. |
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énements initialize retourne une valeur d’énumération
Remarque : Le paramètre reason de la fonction d’écouteur d’événements initialize retourne uniquement une valeur d’énumération |
Office. |
Vérifie si l’ensemble de conditions requises spécifié est pris en charge par l’application Office. |
Office. |
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 bien que cette API soit destinée à être utilisée à l’intérieur d’un complément Office, 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. |
Retourne une promesse d’un objet décrit dans l’expression . Le rappel est appelé uniquement en cas d’échec de la fonction. |
Office. |
Active et désactive l’alias |
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énements initialize retourne une valeur d’énumération InitializationReason
qui spécifie la façon dont 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 sous 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’écouteur d’événements initialize retourne uniquement une valeur d’énumération InitializationReason
pour les compléments du volet Office et du 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 des serveurs et des applications Office, voir Configuration requise pour l’exécution des 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 | |
---|---|---|---|---|---|
Exceller | Pris en charge | Pris en charge | Pris en charge | Pris en charge | Non applicable |
Perspective | 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 |
Mot | 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 == "inserted")
write("The add-in was just inserted.");
if (reason == "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)
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
La 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 bien que cette API soit destinée à être utilisée à l’intérieur d’un complément Office, 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
Fonction de rappel facultative, qui recevra les informations de l’application et de la plateforme. Au lieu d’utiliser un rappel, un complément peut simplement attendre que la promesse retournée par la fonction se résolve.
Retours
Promise<{ host: Office.HostType, platform: Office.PlatformType }>
Promesse qui contient les informations de l’application et de la plateforme, une fois l’initialisation terminée.
Office.select(expression, callback)
Retourne une promesse d’un objet décrit dans l’expression . Le rappel est appelé uniquement en cas d’échec de la fonction.
export function select(expression: string, callback?: (result: AsyncResult<any>) => void): Binding;
Paramètres
- expression
-
string
Objet à récupérer. Exemple de « bindings#BindingName », qui récupère une promesse de liaison pour une liaison nommée « BindingName »
- callback
-
(result: Office.AsyncResult<any>) => void
Optional. Fonction appelée lorsque le rappel est retourné, dont le seul paramètre est de type Office.AsyncResult.
Retours
Remarques
Détails concernant le support
Pour plus d’informations sur la configuration requise des serveurs et des applications Office, voir Configuration requise pour l’exécution des compléments Office.
Applications prises en charge, par plateforme
Office sur le web | Office pour Windows | Office sur iPad | |
---|---|---|---|
Exceller | Pris en charge | Pris en charge | Pris en charge |
Mot | 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
de 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 le 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 des serveurs et des applications Office, voir Configuration requise pour l’exécution des 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 | |
---|---|---|---|---|---|
Exceller | Pris en charge | Pris en charge | Non pris en charge | Pris en charge | Non applicable |
Perspective | 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 |
Mot | 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;
}