Office.EventType enum

Colis:: office

Spécifie le genre de l’événement qui a été déclenché. Retourné par la type propriété d’un *EventArgs objet .

Les compléments pour Project prennent en charge les Office.EventType.ResourceSelectionChangedtypes d’événements , Office.EventType.TaskSelectionChangedet Office.EventType.ViewSelectionChanged .

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.

Remarques

Exemples

// This sample shows how to register an event handler in Outlook.
Office.onReady(() => {
    // Registers an event handler to identify when messages are selected.
    Office.context.mailbox.addHandlerAsync(Office.EventType.SelectedItemsChanged, getMessageProperties, (asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.log(asyncResult.error.message);
            return;
        }

        console.log("Event handler added for the SelectedItemsChanged event.");
    });
});

function getMessageProperties() {
    // Retrieves the selected messages' properties and logs them to the console.
    Office.context.mailbox.getSelectedItemsAsync((asyncResult) => {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.log(asyncResult.error.message);
            return;
        }

        asyncResult.value.forEach((message) => {
            console.log(`Item ID: ${message.itemId}`);
            console.log(`Subject: ${message.subject}`);
            console.log(`Item type: ${message.itemType}`);
            console.log(`Item mode: ${message.itemMode}`);
        });
    });
}

Champs

ActiveViewChanged	Un `Document.ActiveViewChanged` événement a été déclenché dans PowerPoint.
AppointmentTimeChanged	Se produit lorsque la date ou l’heure du rendez-vous ou de la série sélectionnée est modifiée dans Outlook. Important : cet événement ne peut être géré que dans un volet Office. Les commandes de fonction ne peuvent pas inscrire de gestionnaire pour cet événement. Pour ajouter un gestionnaire d’événements pour l’événement `AppointmentTimeChanged` , utilisez la `addHandlerAsync` méthode de l’objet `Item` . Le gestionnaire d’événements reçoit un argument de type Office.AppointmentTimeChangedEventArgs. [ Ensemble d’API : Boîte aux lettres 1.7 ]
AttachmentsChanged	Se produit lorsqu’une pièce jointe est ajoutée ou supprimée d’un élément. Important : cet événement ne peut être géré que dans un volet Office. Les commandes de fonction ne peuvent pas inscrire de gestionnaire pour cet événement. Pour ajouter un gestionnaire d’événements pour l’événement `AttachmentsChanged` , utilisez la `addHandlerAsync` méthode de l’objet `Item` . Le gestionnaire d’événements reçoit un argument de type Office.AttachmentsChangedEventArgs. [ Ensemble d’API : Boîte aux lettres 1.8 ]
BindingDataChanged	Se produit lorsque les données de la liaison sont modifiées dans Excel ou Word. Pour ajouter un gestionnaire d’événements pour l’événement `BindingDataChanged` d’une liaison, utilisez la `addHandlerAsync` méthode de l’objet Binding. Le gestionnaire d’événements reçoit un argument de type Office.BindingDataChangedEventArgs.
BindingSelectionChanged	Se produit lorsque la sélection est modifiée dans la liaison dans Excel ou Word. Pour ajouter un gestionnaire d’événements pour l’événement `BindingSelectionChanged` d’une liaison, utilisez la `addHandlerAsync` méthode de l’objet Binding. Le gestionnaire d’événements reçoit un argument de type Office.BindingSelectionChangedEventArgs.
DialogEventReceived	Se produit lorsqu’un dialogue est fermé ou lorsque la navigation dans le dialogue a échoué. Pour obtenir des conseils sur l’implémentation d’un dialogue dans votre complément, voir Utiliser l’API de boîte de dialogue Office dans les compléments Office.
DialogMessageReceived	Se produit lorsqu’une boîte de dialogue envoie un message à l’aide de `Office.context.ui.messageParent`. Pour obtenir des conseils sur l’implémentation d’un dialogue dans votre complément, voir Utiliser l’API de boîte de dialogue Office dans les compléments Office.
DialogParentMessageReceived	Se produit lorsqu’une page hôte envoie un message à une boîte de dialogue enfant avec `Dialog.messageChild`. Pour obtenir des conseils sur l’implémentation d’un dialogue dans votre complément, voir Utiliser l’API de boîte de dialogue Office dans les compléments Office.
DocumentSelectionChanged	Se produit lorsqu’une sélection au niveau du document se produit dans Excel ou Word.
DragAndDropEvent	Se produit dans Outlook sur le web et le nouvel Outlook sur Windows lorsque des messages ou des pièces jointes dans la fenêtre du client Outlook sont glissés puis déposés dans le volet Office d’un complément. Pour ajouter un gestionnaire d’événements pour l’événement `DragAndDropEvent` , utilisez la `addHandlerAsync` méthode de l’objet `Mailbox` . Le gestionnaire d’événements reçoit un argument de type Office.DragAndDropEventArgs. Important : l’événement `DragAndDropEvent` n’est pas pris en charge dans Outlook sur Windows (classique) et sur Mac. Si le `DragAndDropEvent` gestionnaire s’exécute sur ces clients, une erreur se produit (« Cet événement n’est pas pris en charge sur cette plateforme »). [ Ensemble d’API : Boîte aux lettres 1.5 ]
EnhancedLocationsChanged	Se produit lorsque l’emplacement du rendez-vous est modifié dans Outlook. Important : cet événement ne peut être géré que dans un volet Office. Les commandes de fonction ne peuvent pas inscrire de gestionnaire pour cet événement. Pour ajouter un gestionnaire d’événements pour l’événement `EnhancedLocationsChanged` , utilisez la `addHandlerAsync` méthode de l’objet `Item` . Le gestionnaire d’événements reçoit un argument de type Office.EnhancedLocationsChangedEventArgs. [ Ensemble d’API : Boîte aux lettres 1.8 ]
InfobarClicked	Se produit dans Outlook lorsqu’une action est sélectionnée sur un message de notification avec une action personnalisée définie. Actuellement, Ignorer est la seule action prise en charge qui déclenche cet événement. Pour ajouter un gestionnaire d’événements pour l’événement `InfobarClicked` , utilisez la `addHandlerAsync` méthode de l’objet `Item` . Le gestionnaire d’événements reçoit un argument de type Office.InfobarClickedEventArgs. Important: Cet événement ne peut être géré que dans un volet Office. Les commandes de fonction ne peuvent pas inscrire de gestionnaire pour cet événement. Bien qu’Outlook sur Mac prenne en charge le `InsightMessage` type de notification, il ne prend actuellement pas en charge l’événement `InfobarClicked` . Pour déterminer quand l’action Ignorer est sélectionnée dans la notification, implémentez plutôt un gestionnaire pour l’événement `OnInfoBarDismissClicked` . Pour plus d’informations, consultez Activer des compléments avec des événements. [ Ensemble d’API : Boîte aux lettres 1.10 ]
InitializationContextChanged	Se produit dans Outlook lorsque le volet Office d’un complément est ouvert à partir d’un message actionnable, d’une notification InsightMessage, d’une boîte de dialogue Alertes intelligentes ou d’une boîte de dialogue intégrée de création de rapports de courrier indésirable. Cet événement empêche un complément de se relancer si son volet Office est déjà ouvert dans Outlook. Important : l’événement `InitializationContextChanged` ne peut être géré que dans un volet Office. Les commandes de fonction ne peuvent pas inscrire de gestionnaire pour cet événement. Pour ajouter un gestionnaire d’événements pour l’événement `InitializationContextChanged` , utilisez la `addHandlerAsync` méthode de l’objet `Item` . Le gestionnaire d’événements reçoit un argument de type Office.InitializationContextChangedEventArgs. [ Ensemble d’API : Boîte aux lettres 1.15 ]
ItemChanged	Se produit lorsqu’un autre élément Outlook est sélectionné pour l’affichage pendant que le volet Office est épinglé. Important : cet événement ne peut être géré que dans un volet Office. Les commandes de fonction ne peuvent pas inscrire de gestionnaire pour cet événement. Pour ajouter un gestionnaire d’événements pour l’événement `ItemChanged` , utilisez la `addHandlerAsync` méthode de l’objet `Mailbox` . [ Ensemble d’API : Boîte aux lettres 1.5 ]
NodeDeleted	Se produit lorsqu’un `customXmlPart` nœud est supprimé.
NodeInserted	Se produit lorsqu’un `customXmlPart` nœud est inséré.
NodeReplaced	Se produit lorsqu’un `customXmlPart` nœud est remplacé.
OfficeThemeChanged	Se produit lorsque le paramètre OfficeTheme est modifié dans Outlook. Pour ajouter un gestionnaire d’événements pour l’événement `OfficeThemeChanged` , utilisez la `addHandlerAsync` méthode de l’objet `Mailbox` . Le gestionnaire d’événements reçoit un argument de type Office.OfficeThemeChangedEventArgs. Important: L’événement `OfficeThemeChanged` ne peut être géré que dans un volet Office. Les commandes de fonction ne peuvent pas inscrire de gestionnaire pour cet événement. L’événement `OfficeThemeChanged` n’est pas pris en charge dans les compléments qui implémentent l’activation basée sur les événements. [ Ensemble d’API : Boîte aux lettres 1.14 ]
RecipientsChanged	Se produit lorsque la liste des destinataires de l’élément sélectionné ou de l’emplacement du rendez-vous est modifiée dans Outlook. Important : cet événement ne peut être géré que dans un volet Office. Les commandes de fonction ne peuvent pas inscrire de gestionnaire pour cet événement. Pour ajouter un gestionnaire d’événements pour l’événement `RecipientsChanged` , utilisez la `addHandlerAsync` méthode de l’objet `Item` . Le gestionnaire d’événements reçoit un argument de type Office.RecipientsChangedEventArgs. [ Ensemble d’API : Boîte aux lettres 1.7 ]
RecurrenceChanged	Se produit lorsque le modèle de périodicité de la série sélectionnée est modifié dans Outlook. Important : cet événement ne peut être géré que dans un volet Office. Les commandes de fonction ne peuvent pas inscrire de gestionnaire pour cet événement. Pour ajouter un gestionnaire d’événements pour l’événement `RecurrenceChanged` , utilisez la `addHandlerAsync` méthode de l’objet `Item` . Le gestionnaire d’événements reçoit un argument de type Office.RecurrenceChangedEventArgs. [ Ensemble d’API : Boîte aux lettres 1.7 ]
ResourceSelectionChanged	Se produit lorsqu’une sélection de ressource se produit dans Project.
SelectedItemsChanged	Se produit dans Outlook lorsqu’un ou plusieurs messages sont sélectionnés ou désélectionnés. Important : cet événement ne peut être géré que dans un volet Office. Les commandes de fonction ne peuvent pas inscrire de gestionnaire pour cet événement. Pour ajouter un gestionnaire d’événements pour l’événement `SelectedItemsChanged` , utilisez la `addHandlerAsync` méthode de l’objet `Mailbox` . [ Ensemble d’API : Boîte aux lettres 1.13 ]
SensitivityLabelChanged	Se produit dans Outlook lorsque l’étiquette de confidentialité d’un message ou d’un rendez-vous change. Important : cet événement ne peut être géré que dans un volet Office. Les commandes de fonction ne peuvent pas inscrire de gestionnaire pour cet événement. Pour ajouter un gestionnaire d’événements pour l’événement `SensitivityLabelChanged` , utilisez la `addHandlerAsync` méthode de l’objet `Item` . Le gestionnaire d’événements reçoit un argument de type Office.SensitivityLabelChangedEventArgs. [ Ensemble d’API : Boîte aux lettres 1.13 ]
SettingsChanged	Un `Settings.settingsChanged` événement a été déclenché dans Excel, PowerPoint ou Word.
SpamReporting	Se produit dans Outlook lorsqu’un message non sollicité est signalé. Le gestionnaire d’événements reçoit un argument de type Office.SpamReportingEventArgs. [ Ensemble d’API : Boîte aux lettres 1.14 ]
TaskSelectionChanged	Se produit lorsqu’une sélection de tâche se produit dans Project.
ViewSelectionChanged	Se produit lorsqu’une sélection d’affichage se produit dans Project.

Commentaires

Cette page a-t-elle été utile ?