Office.AddinCommands.Event interface

  • Référence
Paquet:
office

L’objet Event est passé en tant que paramètre aux fonctions de complément appelé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’elle a terminé son traitement.

Remarques

Pour plus d’informations sur la prise en charge dans Excel, Word et PowerPoint, voir Ensembles de conditions requises des commandes de complément.

Les informations suivantes décrivent la prise en charge d’Outlook.

[ Ensemble d’API : Boîte aux lettres 1.3 ]

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 traitement du complément est terminé et qu’il sera automatiquement fermé.

Cette méthode doit être appelée à la fin d’une fonction qui a été appelée par les éléments suivants :

  • Un bouton de commande de fonction (autrement dit, une commande de complément définie avec un <élément Action>, où l’attribut xsi:type a la valeur ).ExecuteFunction

  • Événement défini dans le point d’extension Événements d’un complément d’envoi dans Outlook. Par exemple, un ItemSend événement.

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é

Office.AddinCommands.Source

Remarques

Les informations suivantes décrivent la prise en charge d’Outlook.

[ Ensemble d’API : Boîte aux lettres 1.3 ]

Niveau d’autorisation minimal : restreint

Mode Outlook applicable : Rédiger ou Lire

Exemples

// In this example, consider a button defined in an add-in manifest.
// The following is the XML manifest definition. Below it is the Teams 
// manifest (preview) definition.
//
//<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 Teams manifest (preview) definition is the following.
// Ellipses("...") indicate omitted properties.
//
//     "extensions": [
//         {
//             ...
//             "runtimes": [
//                 {
//                  "id": "CommandsRuntime",
//                  "type": "general",
//                  "code": {
//                      "page": "https://localhost:3000/commands.html",
//                      "script": "https://localhost:3000/commands.js"
//                  },
//                  "lifetime": "short",
//                  "actions": [
//                      {
//                          "id": "testEventObject",
//                          "type": "executeFunction",
//                          "displayName": "testEventObject"
//                      }
//                  ]
//              }
//             ],
//             "ribbons": [
//                 {
//                     ...
//                     "tabs": [
//                         ...
//                         "groups": [
//                             ...
//                             "controls": [
//                                 {
//                                      "id": "eventTestButton",
//                                      "type": "button",
//                                      "label": "Perform an action",
//                                      "icons": [
//                                          {
//                                              "size": 16,
//                                              "file": "https://localhost:3000/assets/blue-icon-16.png"
//                                          },
//                                          {
//                                              "size": 32,
//                                              "file": "https://localhost:3000/assets/blue-icon-32.png"
//                                          },
//                                          {
//                                              "size": 80,
//                                              "file": "https://localhost:3000/assets/blue-icon-80.png"
//                                          }
//                                      ],
//                                      "supertip": {
//                                          "title": "Perform an action",
//                                          "description": "Perform an action when clicked."
//                                      },
//                                      "actionId": "testEventObject"
//                                  }
//                             ]
//                         ]
//                     ]                           
//                 }
//             ]
//         }
//     ]



// The button has an id 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".
    const 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.
    const buttonId = event.source.id;

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

    event.completed();
}

Détails de la méthode

completed(options)

Indique que le traitement du complément est terminé et qu’il sera automatiquement fermé.

Cette méthode doit être appelée à la fin d’une fonction qui a été appelée par les éléments suivants :

  • Un bouton de commande de fonction (autrement dit, une commande de complément définie avec un <élément Action>, où l’attribut xsi:type a la valeur ).ExecuteFunction

  • Événement défini dans le point d’extension Événements d’un complément d’envoi dans Outlook. Par exemple, un ItemSend événement.

completed(options?: EventCompletedOptions): void;

Paramètres

options
Office.AddinCommands.EventCompletedOptions

Facultatif. Objet qui spécifie le comportement d’un complément lors de l’envoi dans Outlook lorsqu’il termine le traitement d’un ItemSend événement.

Retours

void

Remarques

Les informations suivantes décrivent la prise en charge d’Outlook.

[ Ensemble d’API : Boîte aux lettres 1.3 ]

Niveau d’autorisation minimal : restreint

Mode Outlook applicable : Rédiger ou Lire

Important : le options paramètre s’applique uniquement aux compléments Outlook qui implémentent la fonctionnalité d’envoi. Il 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();
}

// In this example, the checkMessage function was registered as an event handler for ItemSend.
function checkMessage(event) {
    // Get the item being sent.
    const 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 the message.
        const notFound = -1;
        const allowEvent = (result.value.indexOf('BLOCK') === notFound);
        event.completed({ allowEvent: allowEvent });
    });
}