Excel.RunOptions interface

Paquet:
excel
Extends

OfficeExtension.RunOptions<Excel.Session>

Remarques

Utilisateur

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-undo-grouping.yaml

// Use the `mergeUndoGroup` property of the `RunOptions` interface to group multiple operations into a single undo action.
await Excel.run({ mergeUndoGroup: true }, async (context) => {
  const workbook = context.workbook;
  const sheet = context.workbook.worksheets.getActiveWorksheet();

  // Apply formatting to multiple ranges.
  const headerRange = sheet.getRange("A1:D1");
  headerRange.format.fill.color = "#4472C4";
  headerRange.format.font.color = "white";
  headerRange.format.font.bold = true;

  await context.sync();

  const dataRange = sheet.getRange("A2:D6");
  dataRange.format.borders.getItem("EdgeTop").style = "Continuous";
  dataRange.format.borders.getItem("EdgeBottom").style = "Continuous";
  dataRange.format.borders.getItem("EdgeLeft").style = "Continuous";
  dataRange.format.borders.getItem("EdgeRight").style = "Continuous";

  await context.sync();

  const totalRow = sheet.getRange("A6:D6");
  totalRow.format.fill.color = "#D9E1F2";
  totalRow.format.font.bold = true;

  // Return focus to the workbook.
  workbook.focus(); // This API is only supported on desktop. In Excel on the web, you must manually return focus to the worksheet after clicking the task pane button.

  await context.sync();

  console.log("Applied formatting with undo grouping. Use Ctrl+Z (Cmd+Z on Mac) once to undo all changes.");
});

Propriétés

delayForCellEdit

Détermine si Excel retardera la demande de lot jusqu’à ce que l’utilisateur quitte le mode d’édition de cellule.

Lorsque false, si l’utilisateur est dans la modification de cellule lorsque la demande de lot est traitée par l’hôte, le lot échoue automatiquement. Lorsque true, la demande de lot est exécutée immédiatement si l’utilisateur n’est pas en mode de modification de cellule, mais si l’utilisateur est en mode de modification de cellule, la demande de lot est retardée jusqu’à ce que l’utilisateur quitte le mode de modification de cellule. Le comportement par défaut sans delayForCellEdit propriété spécifiée est équivalent à lorsqu’il est false.
mergeUndoGroup

Détermine si les demandes de lot doivent être fusionnées dans un groupe d’annulation.

Lorsque la valeur est false, chaque context.sync() appel crée un enregistrement d’annulation. Lorsque la valeur est true, tous les context.sync() appels d’un même Excel.run appel sont fusionnés en un undo seul groupe.

Détails de la propriété

delayForCellEdit

Détermine si Excel retardera la demande de lot jusqu’à ce que l’utilisateur quitte le mode d’édition de cellule.

Lorsque false, si l’utilisateur est dans la modification de cellule lorsque la demande de lot est traitée par l’hôte, le lot échoue automatiquement. Lorsque true, la demande de lot est exécutée immédiatement si l’utilisateur n’est pas en mode de modification de cellule, mais si l’utilisateur est en mode de modification de cellule, la demande de lot est retardée jusqu’à ce que l’utilisateur quitte le mode de modification de cellule. Le comportement par défaut sans delayForCellEdit propriété spécifiée est équivalent à lorsqu’il est false.

delayForCellEdit?: boolean;

Valeur de propriété

boolean

mergeUndoGroup

Détermine si les demandes de lot doivent être fusionnées dans un groupe d’annulation.

Lorsque la valeur est false, chaque context.sync() appel crée un enregistrement d’annulation. Lorsque la valeur est true, tous les context.sync() appels d’un même Excel.run appel sont fusionnés en un undo seul groupe.

mergeUndoGroup?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.20