Excel. Worksheet class

Eigenschaften

autoFilter	Stellt das `AutoFilter` -Objekt des Arbeitsblatts dar.
charts	Gibt eine Auflistung von Diagrammen zurück, die Teil des Arbeitsblatts sind.
comments	Gibt eine Sammlung aller Kommentarobjekte auf dem Arbeitsblatt zurück.
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
customProperties	Ruft eine Auflistung von benutzerdefinierten Eigenschaften auf Arbeitsblattebene ab.
enableCalculation	Bestimmt, ob Excel das Arbeitsblatt bei Bedarf neu berechnen soll. True, wenn Excel das Arbeitsblatt bei Bedarf neu berechnet. False, falls Excel das Arbeitsblatt nicht neu berechnet.
freezePanes	Ruft ein -Objekt ab, das zum Bearbeiten von fixierten Bereichen auf dem Arbeitsblatt verwendet werden kann.
horizontalPageBreaks	Ruft die Sammlung der horizontalen Seitenumbrüche für das Arbeitsblatt ab. Diese Sammlung enthält nur manuelle Seitenumbrüche.
id	Gibt einen Wert zurück, der das Arbeitsblatt in einer bestimmten Arbeitsmappe eindeutig identifiziert. Der Wert des Bezeichners bleibt unverändert, auch wenn das Arbeitsblatt umbenannt oder verschoben wird.
name	Der Anzeigename des Arbeitsblatts.
namedSheetViews	Gibt eine Auflistung von Blattansichten zurück, die im Arbeitsblatt vorhanden sind.
names	Auflistung von Namen im Bereich des aktuellen Arbeitsblatts.
pageLayout	Ruft das `PageLayout` -Objekt des Arbeitsblatts ab.
pivotTables	Die Sammlung von PivotTables, die Teil des Arbeitsblatts sind.
position	Die nullbasiert Position des Arbeitsblatts in der Arbeitsmappe.
protection	Gibt das Blattschutzobjekt für ein Arbeitsblatt zurück.
shapes	Gibt die Sammlung aller Formobjekte auf dem Arbeitsblatt zurück.
showGridlines	Gibt an, ob Gitternetzlinien für den Benutzer sichtbar sind.
showHeadings	Gibt an, ob Überschriften für den Benutzer sichtbar sind.
slicers	Gibt eine Auflistung von Datenschnitten zurück, die Teil des Arbeitsblatts sind.
standardHeight	Gibt die Standardhöhe (Standard) aller Zeilen in der Arbeitsmappe in Punkt zurück.
standardWidth	Gibt die Standardbreite aller Spalten im Arbeitsblatt an. Eine Einheit der Spaltenbreite entspricht der Breite eines Zeichens im Format Normal. Für proportionale Schriftarten wird die Breite des Zeichens 0 (Null) verwendet.
tabColor	Die Registerkartenfarbe des Arbeitsblatts. Wenn das Arbeitsblatt beim Abrufen der Registerkartenfarbe nicht sichtbar ist, lautet `null`der Wert . Wenn das Arbeitsblatt sichtbar ist, aber die Registerkartenfarbe auf Auto festgelegt ist, wird eine leere Zeichenfolge zurückgegeben. Andernfalls wird die Eigenschaft auf eine Farbe in der Form #RRGGBB festgelegt (z. B. "FFA500"). Verwenden Sie beim Festlegen der Farbe eine leere Zeichenfolge, um eine "auto"-Farbe festzulegen, andernfalls eine echte Farbe.
tabId	Gibt einen Wert zurück, der dieses Arbeitsblatt darstellt, das von Open Office XML gelesen werden kann. Dies ist ein ganzzahliger Wert, der sich von `worksheet.id` (der einen global eindeutigen Bezeichner zurückgibt) und `worksheet.name` (der einen Wert wie "Sheet1" zurückgibt).
tables	Gibt die Sammlung von Tabellen zurück, die Teil des Arbeitsblatts sind.
tasks	Gibt eine Auflistung von Aufgaben zurück, die im Arbeitsblatt vorhanden sind.
verticalPageBreaks	Ruft die Sammlung der vertikalen Seitenumbrüche für das Arbeitsblatt ab. Diese Sammlung enthält nur manuelle Seitenumbrüche.
visibility	Die Sichtbarkeit des Arbeitsblatts.

Methoden

activate()	Aktivieren Sie das Arbeitsblatt in der Excel-Benutzeroberfläche.
calculate(markAllDirty)	Berechnet alle Zellen auf einem Arbeitsblatt.
copy(positionType, relativeTo)	Kopiert ein Arbeitsblatt und platziert es an der angegebenen Position.
copy(positionTypeString, relativeTo)	Kopiert ein Arbeitsblatt und platziert es an der angegebenen Position.
delete()	Löscht das Arbeitsblatt aus der Arbeitsmappe. Beachten Sie, dass der Löschvorgang mit einer `InvalidOperation` Ausnahme fehlschlägt, wenn die Sichtbarkeit des Arbeitsblatts auf "VeryHidden" festgelegt ist. Sie sollten die Sichtbarkeit zuerst in ausgeblendet oder sichtbar ändern, bevor Sie sie löschen.
findAll(text, criteria)	Sucht alle Vorkommen der angegebenen Zeichenfolge basierend auf den angegebenen Kriterien und gibt sie als `RangeAreas` Objekt zurück, das einen oder mehrere rechteckige Bereiche umfasst.
findAllOrNullObject(text, criteria)	Sucht alle Vorkommen der angegebenen Zeichenfolge basierend auf den angegebenen Kriterien und gibt sie als `RangeAreas` Objekt zurück, das einen oder mehrere rechteckige Bereiche umfasst.
getCell(row, column)	Ruft das `Range` -Objekt ab, das die einzelne Zelle basierend auf Zeilen- und Spaltennummern enthält. Die Zelle kann sich außerhalb der Grenzen ihres übergeordneten Bereichs befinden, solange sie im Arbeitsblattraster verbleibt.
getNext(visibleOnly)	Ruft das Arbeitsblatt ab, das diesem folgt. Wenn keine Arbeitsblätter folgen, löst diese Methode einen Fehler aus.
getNextOrNullObject(visibleOnly)	Ruft das Arbeitsblatt ab, das diesem folgt. Wenn keine Arbeitsblätter folgen, gibt diese Methode ein -Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getPrevious(visibleOnly)	Ruft das Arbeitsblatt ab, das vor diesem Arbeitsblatt steht. Wenn keine vorherigen Arbeitsblätter vorhanden sind, löst diese Methode einen Fehler aus.
getPreviousOrNullObject(visibleOnly)	Ruft das Arbeitsblatt ab, das vor diesem Arbeitsblatt steht. Wenn keine vorherigen Arbeitsblätter vorhanden sind, gibt diese Methode ein -Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getRange(address)	Ruft das `Range` -Objekt ab, das einen einzelnen rechteckigen Zellblock darstellt, der durch die Adresse oder den Namen angegeben wird.
getRangeByIndexes(startRow, startColumn, rowCount, columnCount)	Ruft das `Range` -Objekt ab, das bei einem bestimmten Zeilen- und Spaltenindex beginnt und eine bestimmte Anzahl von Zeilen und Spalten umfasst.
getRanges(address)	Ruft das `RangeAreas` -Objekt ab, das einen oder mehrere Blöcke rechteckiger Bereiche darstellt, die durch die Adresse oder den Namen angegeben werden.
getUsedRange(valuesOnly)	Der verwendete Bereich ist der kleinste Bereich, der mindestens eine der Zellen umfasst, die einen Wert enthalten oder denen eine Formatierung zugewiesen wurde. Wenn das gesamte Arbeitsblatt leer ist, gibt diese Funktion die zelle oben links zurück (d. h. sie löst keinen Fehler aus).
getUsedRangeOrNullObject(valuesOnly)	Der verwendete Bereich ist der kleinste Bereich, der mindestens eine der Zellen umfasst, die einen Wert enthalten oder denen eine Formatierung zugewiesen wurde. Wenn das gesamte Arbeitsblatt leer ist, gibt diese Methode ein Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
load(options)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "`context.sync()`" aufrufen.
load(propertyNames)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "`context.sync()`" aufrufen.
load(propertyNamesAndPaths)	Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "`context.sync()`" aufrufen.
replaceAll(text, replacement, criteria)	Sucht und ersetzt die angegebene Zeichenfolge auf der Grundlage der auf dem aktuellen Arbeitsblatt angegebenen Kriterien.
set(properties, options)	Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties)	Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
showOutlineLevels(rowLevels, columnLevels)	Zeigt Zeilen- oder Spaltengruppen anhand ihrer Gliederungsebenen an. Beschreibt Gruppen und fasst eine Liste der Daten im Arbeitsblatt zusammen. Die `rowLevels` Parameter und `columnLevels` geben an, wie viele Ebenen der Gliederung angezeigt werden. Der zulässige Argumentbereich liegt zwischen 0 und 8. Der Wert 0 ändert die aktuelle Anzeige nicht. Ein Wert, der größer als die aktuelle Anzahl von Ebenen ist, zeigt alle Ebenen an.
toJSON()	Überschreibt die JavaScript-Methode `toJSON()` , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an `JSON.stringify()`übergeben wird. (`JSON.stringify`ruft wiederum die `toJSON` -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.Worksheet-Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (typisiert als `Excel.Interfaces.WorksheetData`) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Ereignisse

onActivated	Tritt ein, wenn das Arbeitsblatt aktiviert wird.
onCalculated	Tritt ein, wenn das Arbeitsblatt berechnet wird.
onChanged	Tritt auf, wenn sich Daten in einem bestimmten Arbeitsblatt ändern.
onColumnSorted	Tritt auf, wenn eine oder mehrere Spalten sortiert wurden. Dies geschieht als Ergebnis eines Sortiervorgangs von links nach rechts.
onDeactivated	Tritt ein, wenn das Arbeitsblatt deaktiviert wird.
onFiltered	Tritt auf, wenn ein Filter auf ein bestimmtes Arbeitsblatt angewendet wird.
onFormatChanged	Tritt ein, wenn das Format für ein bestimmtes Arbeitsblatt geändert wird.
onFormulaChanged	Tritt auf, wenn eine oder mehrere Formeln in diesem Arbeitsblatt geändert werden. Dieses Ereignis gilt für den Fall, dass sich die Formel selbst ändert, nicht für den Datenwert, der sich aus der Berechnung der Formel ergibt.
onNameChanged	Tritt ein, wenn der Name des Arbeitsblatts geändert wird.
onProtectionChanged	Tritt auf, wenn der Schutzstatus des Arbeitsblatts geändert wird.
onRowHiddenChanged	Tritt auf, wenn sich der ausgeblendete Zustand einer oder mehrerer Zeilen auf einem bestimmten Arbeitsblatt geändert hat.
onRowSorted	Tritt auf, wenn eine oder mehrere Zeilen sortiert wurden. Dies geschieht, wenn Zeilen von oben nach unten sortiert werden.
onSelectionChanged	Tritt auf, wenn sich die Auswahl auf einem bestimmten Arbeitsblatt ändert.
onSingleClicked	Tritt auf, wenn im Arbeitsblatt eine Aktion ausgeführt wird, auf die mit der linken Maustaste geklickt bzw. getippt wird. Dieses Ereignis wird in den folgenden Fällen nicht ausgelöst, wenn Sie auf klicken: Der Benutzer zieht die Maus für die Mehrfachauswahl. Der Benutzer wählt eine Zelle im Modus aus, wenn Zellenargumente für Formelbezüge ausgewählt werden.
onVisibilityChanged	Tritt auf, wenn die Sichtbarkeit des Arbeitsblatts geändert wird.

Details zur Eigenschaft

autoFilter

Stellt das AutoFilter -Objekt des Arbeitsblatts dar.

readonly autoFilter: Excel.AutoFilter;

Eigenschaftswert

Excel.AutoFilter

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml

// This function adds a percentage AutoFilter to the active worksheet 
// and applies the filter to a column of the used range.
await Excel.run(async (context) => {
    // Retrieve the active worksheet and the used range on that worksheet.
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const farmData = sheet.getUsedRange();

    // Add a filter that will only show the rows with the top 50% of values in column 3.
    sheet.autoFilter.apply(farmData, 3, {
        criterion1: "50",
        filterOn: Excel.FilterOn.topPercent
    });

    await context.sync();
});

charts

Gibt eine Auflistung von Diagrammen zurück, die Teil des Arbeitsblatts sind.

readonly charts: Excel.ChartCollection;

Eigenschaftswert

Excel.ChartCollection

Hinweise

comments

Gibt eine Sammlung aller Kommentarobjekte auf dem Arbeitsblatt zurück.

readonly comments: Excel.CommentCollection;

Eigenschaftswert

Excel.CommentCollection

Hinweise

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

customProperties

Ruft eine Auflistung von benutzerdefinierten Eigenschaften auf Arbeitsblattebene ab.

readonly customProperties: Excel.WorksheetCustomPropertyCollection;

Eigenschaftswert

Excel.WorksheetCustomPropertyCollection

Hinweise

[ API-Satz: ExcelApi 1.12 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml

await Excel.run(async (context) => {
  // Load the keys and values of all custom properties in the current worksheet.
  const customWorksheetProperties = context.workbook.worksheets.getActiveWorksheet().customProperties;
  customWorksheetProperties.load(["key", "value"]);
  await context.sync();

  // Log each custom property to the console.
  // Note that your document may have more properties than those you have set using this snippet.
  customWorksheetProperties.items.forEach((property) => {
    console.log(`${property.key}:${property.value}`);
  });
});

enableCalculation

Bestimmt, ob Excel das Arbeitsblatt bei Bedarf neu berechnen soll. True, wenn Excel das Arbeitsblatt bei Bedarf neu berechnet. False, falls Excel das Arbeitsblatt nicht neu berechnet.

enableCalculation: boolean;

Eigenschaftswert

boolean

Hinweise

freezePanes

Ruft ein -Objekt ab, das zum Bearbeiten von fixierten Bereichen auf dem Arbeitsblatt verwendet werden kann.

readonly freezePanes: Excel.WorksheetFreezePanes;

Eigenschaftswert

Excel.WorksheetFreezePanes

Hinweise

horizontalPageBreaks

Ruft die Sammlung der horizontalen Seitenumbrüche für das Arbeitsblatt ab. Diese Sammlung enthält nur manuelle Seitenumbrüche.

readonly horizontalPageBreaks: Excel.PageBreakCollection;

Eigenschaftswert

Excel.PageBreakCollection

Hinweise

id

Gibt einen Wert zurück, der das Arbeitsblatt in einer bestimmten Arbeitsmappe eindeutig identifiziert. Der Wert des Bezeichners bleibt unverändert, auch wenn das Arbeitsblatt umbenannt oder verschoben wird.

readonly id: string;

Eigenschaftswert

string

Hinweise

name

Der Anzeigename des Arbeitsblatts.

name: string;

Eigenschaftswert

string

Hinweise

namedSheetViews

Gibt eine Auflistung von Blattansichten zurück, die im Arbeitsblatt vorhanden sind.

readonly namedSheetViews: Excel.NamedSheetViewCollection;

Eigenschaftswert

Excel.NamedSheetViewCollection

Hinweise

[ API-Satz: ExcelApiOnline 1.1 ]

names

Auflistung von Namen im Bereich des aktuellen Arbeitsblatts.

readonly names: Excel.NamedItemCollection;

Eigenschaftswert

Excel.NamedItemCollection

Hinweise

[ API-Satz: ExcelApi 1.4 ]

pageLayout

Ruft das PageLayout -Objekt des Arbeitsblatts ab.

readonly pageLayout: Excel.PageLayout;

Eigenschaftswert

Excel.PageLayout

Hinweise

pivotTables

Die Sammlung von PivotTables, die Teil des Arbeitsblatts sind.

readonly pivotTables: Excel.PivotTableCollection;

Eigenschaftswert

Excel.PivotTableCollection

Hinweise

[ API-Satz: ExcelApi 1.3 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml

await Excel.run(async (context) => {
  // Get the names of all the PivotTables in the current worksheet.
  const pivotTables = context.workbook.worksheets.getActiveWorksheet().pivotTables;
  pivotTables.load("name");
  await context.sync();

  // Display the names in the console.
  console.log("PivotTables in the current worksheet:")
  pivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
});

position

Die nullbasiert Position des Arbeitsblatts in der Arbeitsmappe.

position: number;

Eigenschaftswert

number

Hinweise

Beispiele

// Set worksheet position.
await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.position = 2;
    await context.sync(); 
});

protection

Gibt das Blattschutzobjekt für ein Arbeitsblatt zurück.

readonly protection: Excel.WorksheetProtection;

Eigenschaftswert

Excel.WorksheetProtection

Hinweise

[ API-Satz: ExcelApi 1.2 ]

Beispiele

// Unprotecting a worksheet with unprotect() will remove all 
// WorksheetProtectionOptions options applied to a worksheet.
// To remove only a subset of WorksheetProtectionOptions use the 
// protect() method and set the options you wish to remove to true.
await Excel.run(async (context) => {
  const sheet = context.workbook.worksheets.getItem("Sheet1");
  sheet.protection.protect({
    allowInsertRows: false, // Protect row insertion
    allowDeleteRows: true // Unprotect row deletion
  });
});

shapes

Gibt die Sammlung aller Formobjekte auf dem Arbeitsblatt zurück.

readonly shapes: Excel.ShapeCollection;

Eigenschaftswert

Excel.ShapeCollection

Hinweise

showGridlines

Gibt an, ob Gitternetzlinien für den Benutzer sichtbar sind.

showGridlines: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.8 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/gridlines.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.showGridlines = true;

    await context.sync();
});

showHeadings

Gibt an, ob Überschriften für den Benutzer sichtbar sind.

showHeadings: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.8 ]

slicers

Gibt eine Auflistung von Datenschnitten zurück, die Teil des Arbeitsblatts sind.

readonly slicers: Excel.SlicerCollection;

Eigenschaftswert

Excel.SlicerCollection

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Pivot");
    const slicer = sheet.slicers.add(
        "Farm Sales", /* The slicer data source. For PivotTables, this can be the PivotTable object reference or name. */
        "Type" /* The field in the data source to filter by. For PivotTables, this can be a PivotField object reference or ID. */
    );
    slicer.name = "Fruit Slicer";
    await context.sync();
});

standardHeight

Gibt die Standardhöhe (Standard) aller Zeilen in der Arbeitsmappe in Punkt zurück.

readonly standardHeight: number;

Eigenschaftswert

number

Hinweise

standardWidth

Gibt die Standardbreite aller Spalten im Arbeitsblatt an. Eine Einheit der Spaltenbreite entspricht der Breite eines Zeichens im Format Normal. Für proportionale Schriftarten wird die Breite des Zeichens 0 (Null) verwendet.

standardWidth: number;

Eigenschaftswert

number

Hinweise

tabColor

Die Registerkartenfarbe des Arbeitsblatts. Wenn das Arbeitsblatt beim Abrufen der Registerkartenfarbe nicht sichtbar ist, lautet nullder Wert . Wenn das Arbeitsblatt sichtbar ist, aber die Registerkartenfarbe auf Auto festgelegt ist, wird eine leere Zeichenfolge zurückgegeben. Andernfalls wird die Eigenschaft auf eine Farbe in der Form #RRGGBB festgelegt (z. B. "FFA500"). Verwenden Sie beim Festlegen der Farbe eine leere Zeichenfolge, um eine "auto"-Farbe festzulegen, andernfalls eine echte Farbe.

tabColor: string;

Eigenschaftswert

string

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/tab-color.yaml

await Excel.run(async (context) => {
    const activeSheet = context.workbook.worksheets.getActiveWorksheet();
    activeSheet.tabColor = "#FF0000";

    await context.sync();
});

tabId

Gibt einen Wert zurück, der dieses Arbeitsblatt darstellt, das von Open Office XML gelesen werden kann. Dies ist ein ganzzahliger Wert, der sich von worksheet.id (der einen global eindeutigen Bezeichner zurückgibt) und worksheet.name (der einen Wert wie "Sheet1" zurückgibt).

readonly tabId: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.14 ]

tables

Gibt die Sammlung von Tabellen zurück, die Teil des Arbeitsblatts sind.

readonly tables: Excel.TableCollection;

Eigenschaftswert

Excel.TableCollection

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

tasks

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt eine Auflistung von Aufgaben zurück, die im Arbeitsblatt vorhanden sind.

readonly tasks: Excel.DocumentTaskCollection;

Eigenschaftswert

Excel.DocumentTaskCollection

Hinweise

verticalPageBreaks

Ruft die Sammlung der vertikalen Seitenumbrüche für das Arbeitsblatt ab. Diese Sammlung enthält nur manuelle Seitenumbrüche.

readonly verticalPageBreaks: Excel.PageBreakCollection;

Eigenschaftswert

Excel.PageBreakCollection

Hinweise

[ API-Satz: ExcelApi 1.1 für die Lesesichtbarkeit; 1.2 zum Festlegen. ]

visibility

Die Sichtbarkeit des Arbeitsblatts.

visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";

Eigenschaftswert

Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"

Hinweise

Details zur Methode

activate()

Aktivieren Sie das Arbeitsblatt in der Excel-Benutzeroberfläche.

activate(): void;

Gibt zurück

void

Hinweise

Beispiele

await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.activate();
    await context.sync(); 
});

calculate(markAllDirty)

Berechnet alle Zellen auf einem Arbeitsblatt.

calculate(markAllDirty: boolean): void;

Parameter

markAllDirty: boolean

True, um alle als modifiziert zu markieren.

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.6 ]

copy(positionType, relativeTo)

Kopiert ein Arbeitsblatt und platziert es an der angegebenen Position.

copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet): Excel.Worksheet;

Parameter

positionType: Excel.WorksheetPositionType

Der Speicherort in der Arbeitsmappe, an dem das neu erstellte Arbeitsblatt platziert werden soll. Der Standardwert ist "None", wodurch das Arbeitsblatt am Anfang des Arbeitsblatts eingefügt wird.

relativeTo: Excel.Worksheet

Das vorhandene Arbeitsblatt, das die Position des neu erstellten Arbeitsblatts bestimmt. Dies ist nur erforderlich, wenn positionType "Vorher" oder "Nach" ist.

Gibt zurück

Excel.Worksheet

Das neu erstellte Arbeitsblatt.

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-copy.yaml

await Excel.run(async (context) => {

    let myWorkbook = context.workbook;
    let sampleSheet = myWorkbook.worksheets.getActiveWorksheet();
    let copiedSheet = sampleSheet.copy("End")

    sampleSheet.load("name");
    copiedSheet.load("name");

    await context.sync();

    console.log("'" + sampleSheet.name + "' was copied to '" + copiedSheet.name + "'")
});

copy(positionTypeString, relativeTo)

Kopiert ein Arbeitsblatt und platziert es an der angegebenen Position.

copy(positionTypeString?: "None" | "Before" | "After" | "Beginning" | "End", relativeTo?: Excel.Worksheet): Excel.Worksheet;

Parameter

positionTypeString: "None" | "Before" | "After" | "Beginning" | "End"

Der Speicherort in der Arbeitsmappe, an dem das neu erstellte Arbeitsblatt platziert werden soll. Der Standardwert ist "None", wodurch das Arbeitsblatt am Anfang des Arbeitsblatts eingefügt wird.

relativeTo: Excel.Worksheet

Das vorhandene Arbeitsblatt, das die Position des neu erstellten Arbeitsblatts bestimmt. Dies ist nur erforderlich, wenn positionType "Vorher" oder "Nach" ist.

Gibt zurück

Excel.Worksheet

Das neu erstellte Arbeitsblatt.

Hinweise

delete()

Löscht das Arbeitsblatt aus der Arbeitsmappe. Beachten Sie, dass der Löschvorgang mit einer InvalidOperation Ausnahme fehlschlägt, wenn die Sichtbarkeit des Arbeitsblatts auf "VeryHidden" festgelegt ist. Sie sollten die Sichtbarkeit zuerst in ausgeblendet oder sichtbar ändern, bevor Sie sie löschen.

delete(): void;

Gibt zurück

void

Hinweise

Beispiele

await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.delete();
    await context.sync(); 
});

findAll(text, criteria)

Sucht alle Vorkommen der angegebenen Zeichenfolge basierend auf den angegebenen Kriterien und gibt sie als RangeAreas Objekt zurück, das einen oder mehrere rechteckige Bereiche umfasst.

findAll(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

Parameter

text: string

Die zu suchde Zeichenfolge.

criteria: Excel.WorksheetSearchCriteria

Zusätzliche Suchkriterien, z. B. ob die Suche mit der gesamten Zelle übereinstimmen oder die Groß-/Kleinschreibung beachtet werden muss.

Gibt zurück

Excel.RangeAreas

Ein RangeAreas -Objekt, das einen oder mehrere rechteckige Bereiche umfasst und den Suchkriterien entspricht. Wenn keine Zellen dieses Kriterium erfüllen, wird ein ItemNotFound Fehler ausgelöst.

Hinweise

findAllOrNullObject(text, criteria)

Sucht alle Vorkommen der angegebenen Zeichenfolge basierend auf den angegebenen Kriterien und gibt sie als RangeAreas Objekt zurück, das einen oder mehrere rechteckige Bereiche umfasst.

findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

Parameter

text: string

Die zu suchde Zeichenfolge.

criteria: Excel.WorksheetSearchCriteria

Zusätzliche Suchkriterien, z. B. ob die Suche mit der gesamten Zelle übereinstimmen oder die Groß-/Kleinschreibung beachtet werden muss.

Gibt zurück

Excel.RangeAreas

Ein RangeAreas -Objekt, das einen oder mehrere rechteckige Bereiche umfasst und den Suchkriterien entspricht. Wenn keine Übereinstimmungen vorhanden sind, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-find-all.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const foundRanges = sheet.findAllOrNullObject("Complete", {
        completeMatch: true,
        matchCase: false
    });

    await context.sync();

    if (foundRanges.isNullObject) {
        console.log("No complete projects");
    } else {
        foundRanges.format.fill.color = "green"
    }
});

getCell(row, column)

Ruft das Range -Objekt ab, das die einzelne Zelle basierend auf Zeilen- und Spaltennummern enthält. Die Zelle kann sich außerhalb der Grenzen ihres übergeordneten Bereichs befinden, solange sie im Arbeitsblattraster verbleibt.

getCell(row: number, column: number): Excel.Range;

Parameter

row: number

Die Zeilenanzahl der abzurufenden Zelle. Nullindiziert.

column: number

Die Spaltenanzahl der abzurufenden Zelle. Nullindiziert.

Gibt zurück

Excel.Range

Hinweise

Beispiele

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const cell = worksheet.getCell(0,0);
    cell.load('address');
    await context.sync();

    console.log(cell.address);
});

getNext(visibleOnly)

Ruft das Arbeitsblatt ab, das diesem folgt. Wenn keine Arbeitsblätter folgen, löst diese Methode einen Fehler aus.

getNext(visibleOnly?: boolean): Excel.Worksheet;

Parameter

visibleOnly: boolean

Optional. Bei truewerden nur sichtbare Arbeitsblätter berücksichtigt, wobei ausgeblendete Arbeitsblätter übersprungen werden.

Gibt zurück

Excel.Worksheet

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml

await Excel.run(async (context) => {
    const sheets = context.workbook.worksheets;

    // We don't want to include the default worksheet that was created
    // when the workbook was created, so our "firstSheet" will be the one
    // after the literal first. Note chaining of navigation methods.
    const firstSheet = sheets.getFirst().getNext();
    const lastSheet = sheets.getLast();
    const firstTaxRateRange = firstSheet.getRange("B2");
    const lastTaxRateRange = lastSheet.getRange("B2");

    firstSheet.load("name");
    lastSheet.load("name");
    firstTaxRateRange.load("text");
    lastTaxRateRange.load("text");

    await context.sync();

    let firstYear = firstSheet.name.substr(5, 4);
    let lastYear = lastSheet.name.substr(5, 4);
    console.log(`Tax Rate change from ${firstYear} to ${lastYear}`, `Tax rate for ${firstYear}: ${firstTaxRateRange.text[0][0]}\nTax rate for ${lastYear}: ${lastTaxRateRange.text[0][0]}`)

    await context.sync();
});

getNextOrNullObject(visibleOnly)

Ruft das Arbeitsblatt ab, das diesem folgt. Wenn keine Arbeitsblätter folgen, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getNextOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

Parameter

visibleOnly: boolean

Optional. Bei truewerden nur sichtbare Arbeitsblätter berücksichtigt, wobei ausgeblendete Arbeitsblätter übersprungen werden.

Gibt zurück

Excel.Worksheet

Hinweise

getPrevious(visibleOnly)

Ruft das Arbeitsblatt ab, das vor diesem Arbeitsblatt steht. Wenn keine vorherigen Arbeitsblätter vorhanden sind, löst diese Methode einen Fehler aus.

getPrevious(visibleOnly?: boolean): Excel.Worksheet;

Parameter

visibleOnly: boolean

Optional. Bei truewerden nur sichtbare Arbeitsblätter berücksichtigt, wobei ausgeblendete Arbeitsblätter übersprungen werden.

Gibt zurück

Excel.Worksheet

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml

await Excel.run(async (context) => {
    const sheets = context.workbook.worksheets;
    const currentSheet = sheets.getActiveWorksheet();
    const previousYearSheet = currentSheet.getPrevious();
    const currentTaxDueRange = currentSheet.getRange("C2");
    const previousTaxDueRange = previousYearSheet.getRange("C2");

    currentSheet.load("name");
    previousYearSheet.load("name");
    currentTaxDueRange.load("text");
    previousTaxDueRange.load("text");

    await context.sync();

    let currentYear = currentSheet.name.substr(5, 4);
    let previousYear = previousYearSheet.name.substr(5, 4);
    console.log("Two Year Tax Due Comparison", `Tax due for ${currentYear} was ${currentTaxDueRange.text[0][0]}\nTax due for ${previousYear} was ${previousTaxDueRange.text[0][0]}`)

    await context.sync();
});

getPreviousOrNullObject(visibleOnly)

Ruft das Arbeitsblatt ab, das vor diesem Arbeitsblatt steht. Wenn keine vorherigen Arbeitsblätter vorhanden sind, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getPreviousOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

Parameter

visibleOnly: boolean

Optional. Bei truewerden nur sichtbare Arbeitsblätter berücksichtigt, wobei ausgeblendete Arbeitsblätter übersprungen werden.

Gibt zurück

Excel.Worksheet

Hinweise

getRange(address)

Ruft das Range -Objekt ab, das einen einzelnen rechteckigen Zellblock darstellt, der durch die Adresse oder den Namen angegeben wird.

getRange(address?: string): Excel.Range;

Parameter

address: string

Optional. Die Zeichenfolge, die die Adresse oder den Namen des Bereichs darstellt. Beispiel: "A1:B2". Wenn nichts angegeben ist, wird der gesamte Arbeitsblattbereich zurückgegeben.

Gibt zurück

Excel.Range

Hinweise

Beispiele

// Use the range address to get the range object.
await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "A1:F8";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    range.load('cellCount');
    await context.sync();
    
    console.log(range.cellCount);
});

getRangeByIndexes(startRow, startColumn, rowCount, columnCount)

Ruft das Range -Objekt ab, das bei einem bestimmten Zeilen- und Spaltenindex beginnt und eine bestimmte Anzahl von Zeilen und Spalten umfasst.

getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number): Excel.Range;

Parameter

startRow: number

Startzeile (nullindiziert).

startColumn: number

Startspalte (nullindiziert).

rowCount: number

Anzahl der Zeilen, die in den Bereich eingeschlossen werden sollen.

columnCount: number

Anzahl der Spalten, die in den Bereich eingeschlossen werden sollen.

Gibt zurück

Excel.Range

Hinweise

getRanges(address)

Ruft das RangeAreas -Objekt ab, das einen oder mehrere Blöcke rechteckiger Bereiche darstellt, die durch die Adresse oder den Namen angegeben werden.

getRanges(address?: string): Excel.RangeAreas;

Parameter

address: string

Optional. Eine Zeichenfolge, die die durch Trennzeichen oder Semikolons getrennten Adressen oder Namen der einzelnen Bereiche enthält. Beispiel: "A1:B2, A5:B5" oder "A1:B2; A5:B5". Wenn keine Angabe erfolgt, wird ein RangeAreas -Objekt für das gesamte Arbeitsblatt zurückgegeben.

Gibt zurück

Excel.RangeAreas

Hinweise

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml

await Excel.run(async (context) => {

    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const specifiedRanges = sheet.getRanges("D3:D5, G3:G5");
    specifiedRanges.format.fill.color = "pink";

    await context.sync();
})

getUsedRange(valuesOnly)

Der verwendete Bereich ist der kleinste Bereich, der mindestens eine der Zellen umfasst, die einen Wert enthalten oder denen eine Formatierung zugewiesen wurde. Wenn das gesamte Arbeitsblatt leer ist, gibt diese Funktion die zelle oben links zurück (d. h. sie löst keinen Fehler aus).

getUsedRange(valuesOnly?: boolean): Excel.Range;

Parameter

valuesOnly: boolean

Optional. Bei truewerden nur Zellen mit Werten als verwendete Zellen betrachtet (Formatierung wird ignoriert). [API-Satz: ExcelApi 1.2]

Gibt zurück

Excel.Range

Hinweise

Beispiele

await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    const usedRange = worksheet.getUsedRange();
    usedRange.load('address');
    await context.sync();
    
    console.log(usedRange.address);
});

getUsedRangeOrNullObject(valuesOnly)

Der verwendete Bereich ist der kleinste Bereich, der mindestens eine der Zellen umfasst, die einen Wert enthalten oder denen eine Formatierung zugewiesen wurde. Wenn das gesamte Arbeitsblatt leer ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;

Parameter

valuesOnly: boolean

Optional. Betrachtet nur Zellen mit Werten als verwendet.

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.4 ]

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Excel.Interfaces.WorksheetLoadOptions): Excel.Worksheet;

Parameter

options: Excel.Interfaces.WorksheetLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Excel.Worksheet

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Excel.Worksheet;

Parameter

propertyNames: string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Excel.Worksheet

Beispiele

// Get worksheet properties based on sheet name.
await Excel.run(async (context) => { 
    const wSheetName = 'Sheet1';
    const worksheet = context.workbook.worksheets.getItem(wSheetName);
    worksheet.load('position')
    await context.sync();
    
    console.log(worksheet.position);
});

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Worksheet;

Parameter

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Excel.Worksheet

replaceAll(text, replacement, criteria)

Sucht und ersetzt die angegebene Zeichenfolge auf der Grundlage der auf dem aktuellen Arbeitsblatt angegebenen Kriterien.

replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult<number>;

Parameter

text: string

Zeichenfolge, die gesucht werden soll.

replacement: string

Die Zeichenfolge, die die ursprüngliche Zeichenfolge ersetzt.

criteria: Excel.ReplaceCriteria

Zusätzliche Ersatzkriterien.

Gibt zurück

OfficeExtension.ClientResult<number>

Die Anzahl der ausgeführten Ersetzungen.

Hinweise

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties: Interfaces.WorksheetUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties: Excel.Interfaces.WorksheetUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options: OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

Beispiele

// Set the color and name of the current worksheet.
await Excel.run(async (context) => {
  const activeSheet = context.workbook.worksheets.getActiveWorksheet();
  activeSheet.set({
    tabColor: "yellow",
    name: "MySheet"
  });

  await context.sync();
});

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.Worksheet): void;

Parameter

properties: Excel.Worksheet

Gibt zurück

void

showOutlineLevels(rowLevels, columnLevels)

Zeigt Zeilen- oder Spaltengruppen anhand ihrer Gliederungsebenen an. Beschreibt Gruppen und fasst eine Liste der Daten im Arbeitsblatt zusammen. Die rowLevels Parameter und columnLevels geben an, wie viele Ebenen der Gliederung angezeigt werden. Der zulässige Argumentbereich liegt zwischen 0 und 8. Der Wert 0 ändert die aktuelle Anzeige nicht. Ein Wert, der größer als die aktuelle Anzahl von Ebenen ist, zeigt alle Ebenen an.

showOutlineLevels(rowLevels: number, columnLevels: number): void;

Parameter

rowLevels: number

Die Anzahl der zeilenebenen einer Gliederung, die angezeigt werden soll.

columnLevels: number

Die Anzahl der anzuzeigenden Spaltenebenen einer Gliederung.

Gibt zurück

void

Hinweise

OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/outline.yaml

Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // This shows the top 3 outline levels; collapsing any additional sublevels.
    sheet.showOutlineLevels(3, 3);
    await context.sync();
});

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.Worksheet-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.WorksheetData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.WorksheetData;

Gibt zurück

Excel.Interfaces.WorksheetData

Details zum Ereignis

onActivated

Tritt ein, wenn das Arbeitsblatt aktiviert wird.

readonly onActivated: OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>;

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>

Beispiele

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onActivated.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The activated worksheet ID is: " + event.worksheetId);
            await context.sync();
        });
    });
    await context.sync();
});

onCalculated

Tritt ein, wenn das Arbeitsblatt berechnet wird.

readonly onCalculated: OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>;

Ereignistyp

Hinweise

[ API-Satz: ExcelApi 1.8 ]

Beispiele

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onCalculated.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The worksheet has recalculated.");
            await context.sync();
        });
    });
    await context.sync();
});

onChanged

Tritt auf, wenn sich Daten in einem bestimmten Arbeitsblatt ändern.

readonly onChanged: OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>

Hinweise

OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onChanged.add(onChange);
    await context.sync();

    console.log("Added a worksheet-level data-changed event handler.");
});

onColumnSorted

Tritt auf, wenn eine oder mehrere Spalten sortiert wurden. Dies geschieht als Ergebnis eines Sortiervorgangs von links nach rechts.

readonly onColumnSorted: OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>;

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml

await Excel.run(async (context) => {
    console.log("Adding column handler");
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // This will fire whenever a column has been moved as the result of a sort action.
    sheet.onColumnSorted.add((event) => {
        return Excel.run((context) => {
            console.log("Column sorted: " + event.address);
            const sheet = context.workbook.worksheets.getActiveWorksheet();

            // Clear formatting for section, then highlight the sorted area.
            sheet.getRange("A1:E5").format.fill.clear();
            if (event.address !== "") {
                sheet.getRanges(event.address).format.fill.color = "yellow";
            }

            return context.sync();
        });
    });
});

onDeactivated

Tritt ein, wenn das Arbeitsblatt deaktiviert wird.

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>;

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Excel.WorksheetFilteredEventArgs>

Beispiele

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onDeactivated.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The deactivated worksheet is: " + event.worksheetId);
            await context.sync();
        });
    });
    await context.sync();
});

onFiltered

Hinweis

Tritt auf, wenn ein Filter auf ein bestimmtes Arbeitsblatt angewendet wird.

readonly onFiltered: OfficeExtension.EventHandlers<Excel.WorksheetFilteredEventArgs>;

Ereignistyp

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

onFormatChanged

Tritt ein, wenn das Format für ein bestimmtes Arbeitsblatt geändert wird.

readonly onFormatChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>

Hinweise

OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>

onFormulaChanged

Tritt auf, wenn eine oder mehrere Formeln in diesem Arbeitsblatt geändert werden. Dieses Ereignis gilt für den Fall, dass sich die Formel selbst ändert, nicht für den Datenwert, der sich aus der Berechnung der Formel ergibt.

readonly onFormulaChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>;

Ereignistyp

Hinweise

[ API-Satz: ExcelApi 1.13 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-formula-changed.yaml

await Excel.run(async (context) => {
  // Retrieve the worksheet named "Sample".
  let sheet = context.workbook.worksheets.getItem("Sample");
  
  // Register the formula changed event handler for this worksheet.
  sheet.onFormulaChanged.add(formulaChangeHandler);
  await context.sync();
  
  console.log("Registered a formula changed event handler for this worksheet.");
});

...

async function formulaChangeHandler(event: Excel.WorksheetFormulaChangedEventArgs) {
  await Excel.run(async (context) => {
    // Retrieve details about the formula change event.
    const cellAddress = event.formulaDetails[0].cellAddress;
    const previousFormula = event.formulaDetails[0].previousFormula;
    const source = event.source;
    
    // Print out the change event details.
    console.log(
      `The formula in cell ${cellAddress} changed. 
      The previous formula was: ${previousFormula}. 
      The source of the change was: ${source}.`
    );
  });
}

onNameChanged

Tritt ein, wenn der Name des Arbeitsblatts geändert wird.

readonly onNameChanged: OfficeExtension.EventHandlers<Excel.WorksheetNameChangedEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Excel.WorksheetNameChangedEventArgs>

Hinweise

[ API-Satz: ExcelApi 1.17 ]

onProtectionChanged

Tritt auf, wenn der Schutzstatus des Arbeitsblatts geändert wird.

readonly onProtectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetProtectionChangedEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Excel.WorksheetProtectionChangedEventArgs>

Hinweise

[ API-Satz: ExcelApi 1.14 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-worksheet-protection.yaml

// This function registers an event handler for the onProtectionChanged event of a worksheet.
await Excel.run(async (context) => {
    // Set "Sample" as the active worksheet.
    context.workbook.worksheets.getItemOrNullObject("Sample").delete();
    const sheet = context.workbook.worksheets.add("Sample");
    sheet.activate();

    // Register the onProtectionChanged event handler.
    sheet.onProtectionChanged.add(checkProtection);
    await context.sync();
    console.log("Added a worksheet protection change event handler.");
});

...

async function checkProtection(event: Excel.WorksheetProtectionChangedEventArgs) {
    // This function is an event handler that returns the protection status of a worksheet
    // and information about the changed worksheet.
    await Excel.run(async (context) => {
        const protectionStatus = event.isProtected;
        const worksheetId = event.worksheetId;
        const source = event.source;
        console.log("Protection status changed. Protection status is now: " + protectionStatus + ".");
        console.log("    ID of changed worksheet: " + worksheetId + ".");
        console.log("    Source of change event: " + source + ".");
    });
}

onRowHiddenChanged

Tritt auf, wenn sich der ausgeblendete Zustand einer oder mehrerer Zeilen auf einem bestimmten Arbeitsblatt geändert hat.

readonly onRowHiddenChanged: OfficeExtension.EventHandlers<Excel.WorksheetRowHiddenChangedEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Excel.WorksheetRowHiddenChangedEventArgs>

Hinweise

[ API-Satz: ExcelApi 1.11 ]

Beispiele

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.onRowHiddenChanged.add(function (event) {
        return Excel.run(async (context) => {
            console.log(`Row ${event.address} is now ${event.changeType}`);
            await context.sync();
        });
    });
    await context.sync();
});

onRowSorted

Tritt auf, wenn eine oder mehrere Zeilen sortiert wurden. Dies geschieht, wenn Zeilen von oben nach unten sortiert werden.

readonly onRowSorted: OfficeExtension.EventHandlers<Excel.WorksheetRowSortedEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Excel.WorksheetRowSortedEventArgs>

Hinweise

OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/event-column-and-row-sort.yaml

await Excel.run(async (context) => {
    console.log("Adding row handler");
    const sheet = context.workbook.worksheets.getActiveWorksheet();

    // This will fire whenever a row has been moved as the result of a sort action.
    sheet.onRowSorted.add((event) => {
        return Excel.run((context) => {
            console.log("Row sorted: " + event.address);
            const sheet = context.workbook.worksheets.getActiveWorksheet();

            // Clear formatting for section, then highlight the sorted area.
            sheet.getRange("A1:E5").format.fill.clear();
            if (event.address !== "") {
                sheet.getRanges(event.address).format.fill.color = "yellow";
            }

            return context.sync();
        });
    });
});

onSelectionChanged

Tritt auf, wenn sich die Auswahl auf einem bestimmten Arbeitsblatt ändert.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>;

Ereignistyp

Hinweise

OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>

Beispiele

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.onSelectionChanged.add(function (event) {
        return Excel.run(async (context) => {
            console.log("The selected range has changed to: " + event.address);
            await context.sync();
        });
    });
    await context.sync();
});

onSingleClicked

Tritt auf, wenn im Arbeitsblatt eine Aktion ausgeführt wird, auf die mit der linken Maustaste geklickt bzw. getippt wird. Dieses Ereignis wird in den folgenden Fällen nicht ausgelöst, wenn Sie auf klicken:

Der Benutzer zieht die Maus für die Mehrfachauswahl.
Der Benutzer wählt eine Zelle im Modus aus, wenn Zellenargumente für Formelbezüge ausgewählt werden.

readonly onSingleClicked: OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>;

Ereignistyp

Hinweise