Office.AddinCommands.Event interface

L’objet Event est transmis en tant que paramètre aux fonctions de complément appelées par des boutons de commande sans interface utilisateur. Cet objet permet au complément d’identifier le bouton sur lequel l’utilisateur a cliqué et d’informer l’hôte que son traitement est terminé.

Remarques

Pour plus d’informations sur la prise en charge, voir les ensembles de conditions requises des commandes de module complémentaire.

Niveau d’autorisation minimal (Outlook): Restreint

Mode Outlook applicable  : Rédiger ou Lire

Propriétés

source

Informations sur le contrôle qui a déclenché l’appel de cette fonction.

Méthodes

completed(options)

Indique que le add-in a terminé le traitement et qu’il sera automatiquement fermé.

Cette méthode doit être appelée à la fin d’une fonction qui a été appelée par ce qui suit.

  • Bouton sans interface utilisateur (c’est-à-dire, une commande de add-in Action xsi:type définie avec un élément où l’attribut est défini sur ExecuteFunction)

  • Événement défini dans le point d’extension Events, par exemple, un événement ItemSend

[Ensemble d’API : Mailbox 1.3 ]

Détails de la propriété

source

Informations sur le contrôle qui a déclenché l’appel de cette fonction.

source:Source;

Valeur de propriété

Remarques

Cette propriété est prise en charge Outlook uniquement dans l’ensemble de conditions requises Mailbox 1.3 et ultérieur.

Exemples

// In this example, consider a button defined in an add-in manifest as follows:
//<Control xsi:type="Button" id="eventTestButton">
//    <Label resid="eventButtonLabel" />
//    <Tooltip resid="eventButtonTooltip" />
//    <Supertip>
//        <Title resid="eventSuperTipTitle" />
//        <Description resid="eventSuperTipDescription" />
//    </Supertip>
//    <Icon>
//        <bt:Image size="16" resid="blue-icon-16" />
//        <bt:Image size="32" resid="blue-icon-32" />
//        <bt:Image size="80" resid="blue-icon-80" />
//    </Icon>
//    <Action xsi:type="ExecuteFunction">
//        <FunctionName>testEventObject</FunctionName>
//    </Action>
//</Control>

// The button has an id attribute set to eventTestButton, and will invoke
// the testEventObject function defined in the add-in.
// That function looks like this:
function testEventObject(event) {
    // The event object implements the Event interface.

    // This value will be "eventTestButton".
    var buttonId = event.source.id;

    // Signal to the host app that processing is complete.
    event.completed();
}
// Function is used by two buttons:
// button1 and button2
function multiButton (event) {
    // Check which button was clicked.
    var buttonId = event.source.id;

    if (buttonId === 'button1') {
        doButton1Action();
    } else {
        doButton2Action();
    }

    event.completed();
}

Détails de la méthode

completed(options)

Indique que le add-in a terminé le traitement et qu’il sera automatiquement fermé.

Cette méthode doit être appelée à la fin d’une fonction qui a été appelée par ce qui suit.

  • Bouton sans interface utilisateur (c’est-à-dire, une commande de add-in Action xsi:type définie avec un élément où l’attribut est défini sur ExecuteFunction)

  • Événement défini dans le point d’extension Events, par exemple, un événement ItemSend

[Ensemble d’API : Mailbox 1.3 ]

completed(options?: EventCompletedOptions): void;

Paramètres

options
Office.AddinCommands.EventCompletedOptions

Facultatif. Objet qui spécifie les options de comportement pour la fin de l’événement.

Retours

void

Remarques

Niveau d’autorisation minimal : Restricted

Mode Outlook applicable  : Rédiger ou Lire

Remarque : le paramètre options a été introduit dans Mailbox 1.8.

Exemples

// For the following example, the processItem function is
// defined in the FunctionFile referenced from the add-in manifest,
// and maps to the FunctionName of the action in the associated button control.
function processItem(event) {
    // Do some processing

    event.completed();
}
// For the following example, the checkMessage function was
// registered as an event handler for ItemSend.
function checkMessage(event) {
    // Get the item being sent.
    var outgoingMsg = Office.context.mailbox.item;

    // Check if subject contains "BLOCK".
    outgoingMsg.subject.getAsync(function (result) {
        // Subject is in `result.value`.
        // If search term "BLOCK" is found, don't send message.
        const notFound = -1;
        var allowEvent = (result.value.indexOf('BLOCK') === notFound);
        event.completed({allowEvent: allowEvent});
    });
}