Excel.RunOptions interface

Paket:
excel
Extends

OfficeExtension.RunOptions<Excel.Session>

Hinweise

Verwendet von

Beispiele

// 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.");
});

Eigenschaften

delayForCellEdit

Bestimmt, ob Excel die Batchanforderung verzögert, bis der Benutzer den Zellbearbeitungsmodus verlässt.

Wenn false, wenn sich der Benutzer in der Zellenbearbeitung befindet, wenn die Batchanforderung vom Host verarbeitet wird, schlägt der Batch automatisch fehl. Wenn true, wird die Batchanforderung sofort ausgeführt, wenn sich der Benutzer nicht im Zellbearbeitungsmodus befindet, aber wenn sich der Benutzer im Zellbearbeitungsmodus befindet, wird die Batchanforderung verzögert, bis der Benutzer den Zellbearbeitungsmodus verlässt. Das Standardverhalten ohne delayForCellEdit Angabe von Eigenschaft entspricht dem Standardverhalten, wenn es falseist.
mergeUndoGroup

Bestimmt, ob die Batchanforderungen zu einer Rückgängig-Gruppe zusammengeführt werden sollen.

Bei "false" erstellt jeder context.sync() Aufruf einen Rückgängig-Datensatz. Bei TRUE werden alle context.sync() Aufrufe in einem einzelnen Excel.run zu einer undo Gruppe zusammengeführt.

Details zur Eigenschaft

delayForCellEdit

Bestimmt, ob Excel die Batchanforderung verzögert, bis der Benutzer den Zellbearbeitungsmodus verlässt.

Wenn false, wenn sich der Benutzer in der Zellenbearbeitung befindet, wenn die Batchanforderung vom Host verarbeitet wird, schlägt der Batch automatisch fehl. Wenn true, wird die Batchanforderung sofort ausgeführt, wenn sich der Benutzer nicht im Zellbearbeitungsmodus befindet, aber wenn sich der Benutzer im Zellbearbeitungsmodus befindet, wird die Batchanforderung verzögert, bis der Benutzer den Zellbearbeitungsmodus verlässt. Das Standardverhalten ohne delayForCellEdit Angabe von Eigenschaft entspricht dem Standardverhalten, wenn es falseist.

delayForCellEdit?: boolean;

Eigenschaftswert

boolean

mergeUndoGroup

Bestimmt, ob die Batchanforderungen zu einer Rückgängig-Gruppe zusammengeführt werden sollen.

Bei "false" erstellt jeder context.sync() Aufruf einen Rückgängig-Datensatz. Bei TRUE werden alle context.sync() Aufrufe in einem einzelnen Excel.run zu einer undo Gruppe zusammengeführt.

mergeUndoGroup?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.20