Annuler la prise en charge avec l’API JavaScript Excel

Les compléments Excel prennent en charge le comportement d’annulation. Cela permet de conserver à la fois les actions effectuées par les API JavaScript Excel et les actions effectuées par l’utilisateur dans Excel. Ces actions sont enregistrées dans la pile d’annulation pour un utilisateur individuel, ce qui permet à l’utilisateur de revenir en arrière sur ses actions quand il le souhaite.

Annuler le regroupement

L’API JavaScript Excel prend également en charge le regroupement d’annulation. Cela vous permet de regrouper plusieurs appels d’API en une seule action annulable pour l’utilisateur de votre complément. Par exemple, si votre complément doit effectuer plusieurs mises à jour différentes sur plusieurs feuilles de calcul en réponse à une commande utilisateur unique, vous pouvez inclure toutes ces mises à jour dans un seul groupe. Cette opération s’effectue avec la mergeUndoGroup propriété fournie à la Excel.run fonction .

Si une API au sein du groupe n’offre pas la prise en charge de l’annulation, l’erreur UndoNotSupported est générée pour vous informer que l’opération ne peut pas être regroupée. Votre complément doit gérer correctement cette erreur et présenter un message raisonnable à l’utilisateur.

L’exemple de code suivant montre comment fusionner plusieurs actions avec mergeUndoGroup la valeur définie sur true.

await Excel.run({ mergeUndoGroup: true }, async (context) => { 
    const sheet = context.workbook.worksheets.getActiveWorksheet(); 
    let range = sheet.getRange("A1"); 
    range.values = [["123"]]; 
    
    await context.sync(); 
    
    range = sheet.getRange("B2"); 
    range.values = [["456"]];

    await context.sync(); 
}); 

API non prises en charge

La plupart des API JavaScript Excel prennent en charge les actions d’annulation. Toutefois, consultez le tableau suivant pour obtenir la liste des API qui ne prennent pas en charge le comportement d’annulation.

Voir aussi

• Modèle d’objet JavaScript Excel dans les compléments Office