Excel.Worksheet class

Stellt das AutoFilter Objekt des Arbeitsblatts dar.

readonly autoFilter: Excel.AutoFilter;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.9

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();
});

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

readonly charts: Excel.ChartCollection;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

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

readonly comments: Excel.CommentCollection;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.10

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

context: RequestContext;

Eigenschaftswert

Ruft eine Auflistung benutzerdefinierter Eigenschaften auf Arbeitsblattebene ab.

readonly customProperties: Excel.WorksheetCustomPropertyCollection;

Eigenschaftswert

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}`);
  });
});

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

enableCalculation: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.9

Ruft ein Objekt ab, mit dem fixierte Bereiche im Arbeitsblatt bearbeitet werden können.

readonly freezePanes: Excel.WorksheetFreezePanes;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.7

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

Hinweise

API-Satz: ExcelApi 1.9

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

Hinweise

API-Satz: ExcelApi 1.1

Der Anzeigename des Arbeitsblatts. Der Name muss weniger als 32 Zeichen enthalten.

name: string;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

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

readonly namedSheetViews: Excel.NamedSheetViewCollection;

Eigenschaftswert

Hinweise

API-Satz: ExcelApiOnline 1.1

Auflistung von Namen im Bereich des aktuellen Arbeitsblatts.

readonly names: Excel.NamedItemCollection;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.4

Gibt eine Auflistung aller Notizenobjekte im Arbeitsblatt zurück.

readonly notes: Excel.NoteCollection;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.18

Ruft das PageLayout Objekt des Arbeitsblatts ab.

readonly pageLayout: Excel.PageLayout;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.9

Die Sammlung von PivotTables, die Teil des Arbeitsblatts sind.

readonly pivotTables: Excel.PivotTableCollection;

Eigenschaftswert

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}`);
  });
});

Die nullbasiert Position des Arbeitsblatts in der Arbeitsmappe.

position: number;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

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(); 
});

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

readonly protection: Excel.WorksheetProtection;

Eigenschaftswert

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
  });
});

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

readonly shapes: Excel.ShapeCollection;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.9

Gibt an, ob auf dem Arbeitsblatt Datentypsymbole sichtbar sind. Standardmäßig sind die Symbole für Datentypen sichtbar.

showDataTypeIcons: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.19

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

showGridlines: boolean;

Eigenschaftswert

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();
});

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

showHeadings: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.8

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

readonly slicers: Excel.SlicerCollection;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.10

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();
});

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

readonly standardHeight: number;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.7

Gibt die Standardbreite (Standardbreite) für alle 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

Hinweise

API-Satz: ExcelApi 1.7

Die Registerfarbe des Arbeitsblatts. Wenn das Arbeitsblatt beim Abrufen der Registerfarbe unsichtbar ist, lautet nullder Wert . Wenn das Arbeitsblatt sichtbar ist, die Registerfarbe jedoch auf automatisch 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 Zeichenkette, um eine "automatische" Farbe einzustellen, oder andernfalls eine echte Farbe.

tabColor: string;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.7

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();
});

Gibt einen Wert zurück, der dieses Arbeitsblatt darstellt und 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) unterscheidet.

readonly tabId: number;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.14

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

readonly tables: Excel.TableCollection;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Gibt eine Auflistung der Aufgaben zurück, die auf dem Arbeitsblatt vorhanden sind.

readonly tasks: Excel.DocumentTaskCollection;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi BETA (NUR VORSCHAU)

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

Hinweise

API-Satz: ExcelApi 1.9

Die Sichtbarkeit des Arbeitsblatts.

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

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1 für Lesesichtbarkeit; 1.2 für die Einstellung.

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

activate(): void;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.1

Beispiele

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

Berechnet alle Zellen auf einem Arbeitsblatt.

calculate(markAllDirty: boolean): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.6

Überprüft die Rechtschreibung der Wörter in diesem Arbeitsblatt. Mit dieser Methode wird das Dialogfeld "Rechtschreibung" auf der Excel-Benutzeroberfläche geöffnet.

checkSpelling(options?: Excel.CheckSpellingOptions): void;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApiDesktop 1.1

Löscht die Spurpfeile auf dem Arbeitsblatt.

clearArrows(): void;

Gibt zurück

Hinweise

API-Satz: ExcelApiDesktop 1.1

Kopiert ein Arbeitsblatt und platziert es an der angegebenen Position.

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

Parameter

Gibt zurück

Das neu erstellte Arbeitsblatt.

Hinweise

API-Satz: ExcelApi 1.7

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 + "'")
});

Kopiert ein Arbeitsblatt und platziert es an der angegebenen Position.

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

Parameter

Gibt zurück

Das neu erstellte Arbeitsblatt.

Hinweise

API-Satz: ExcelApi 1.7

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

Hinweise

API-Satz: ExcelApi 1.1

Beispiele

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

Gibt das Auswertungsergebnis einer Formelzeichenfolge zurück. Nur die Formeleingabe wird unterstützt. Wenn der Formelname ungültig ist, wird der InvalidArgument Fehler ausgelöst.

evaluate(name: string): OfficeExtension.ClientResult<any>;

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApiDesktop 1.1

Sucht alle Vorkommen der angegebenen Zeichenfolge anhand der angegebenen Kriterien und gibt sie als RangeAreas Objekt zurück, das aus einem oder mehreren rechteckigen Bereichen besteht. Inhalte in ausgeblendeten Arbeitsblättern werden nicht zurückgegeben.

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

Parameter

Gibt zurück

Ein RangeAreas Objekt, das aus einem oder mehreren rechteckigen Bereichen besteht, das den Suchkriterien entspricht. Wenn keine der Zellen diese Kriterien erfüllen, wird ein ItemNotFound Fehler ausgelöst.

Hinweise

API-Satz: ExcelApi 1.9

Sucht alle Vorkommen der angegebenen Zeichenfolge anhand der angegebenen Kriterien und gibt sie als RangeAreas Objekt zurück, das aus einem oder mehreren rechteckigen Bereichen besteht. Inhalte in ausgeblendeten Arbeitsblättern werden nicht zurückgegeben.

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

Parameter

Gibt zurück

Ein RangeAreas Objekt, das aus einem oder mehreren rechteckigen Bereichen besteht, das den Suchkriterien entspricht. Wenn keine Übereinstimmungen vorhanden sind, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

Hinweise

API-Satz: ExcelApi 1.9

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

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.1

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);
});

Ruft das folgende Arbeitsblatt ab. Wenn keine Arbeitsblätter nach dieser Methode vorhanden sind, wird bei dieser Methode ein Fehler angezeigt.

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

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.5

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();
});

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.5

Ruft das Arbeitsblatt ab, das diesem vorhergeht. Wenn keine vorherigen Arbeitsblätter vorhanden sind, gibt diese Methode einen Fehler aus.

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

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.5

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();
});

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.5

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

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

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.1

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);
});

Ruft das Range Objekt ab einem bestimmten Zeilen- und Spaltenindex ab und erstreckt sich über eine bestimmte Anzahl von Zeilen und Spalten.

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

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.7

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

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.9

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();
})

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 obere linke Zelle zurück (d. h. es wird kein Fehler ausgegeben).

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

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.1

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);
});

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 festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

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

Parameter

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.4

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

Gibt zurück

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

Gibt zurück

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);
});

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

Gibt zurück

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

Gibt zurück

Die Anzahl der durchgeführten Ersetzungen.

Hinweise

API-Satz: ExcelApi 1.9

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

Gibt zurück

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();
});

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

set(properties: Excel.Worksheet): void;

Parameter

Gibt zurück

Zeigt Zeilen- oder Spaltengruppen nach ihren Gliederungsebenen an. Gliedert gruppiert und fasst eine Liste von Daten im Arbeitsblatt zusammen. Die rowLevels Parameter and columnLevels geben an, wie viele Ebenen der Gliederung angezeigt werden. Der zulässige Argumentbereich liegt zwischen 0 und 8. Ein Wert von 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

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.10

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();
});

Ü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 sie übergeben wird.) Während das ursprüngliche Excel.Worksheet Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.WorksheetData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Excel.Interfaces.WorksheetData;

Gibt zurück

Tritt auf, wenn das Arbeitsblatt aktiviert wird.

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

Ereignistyp

Hinweise

API-Satz: ExcelApi 1.7

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();
});

Tritt beim Berechnen des Arbeitsblatts auf.

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();
});

Tritt auf, wenn Zellen im Arbeitsblatt asynchron berechnet werden.

Dieses Ereignis wird, ähnlich wie das onCalculated Ereignis, am Ende eines Berechnungszyklus ausgelöst. Normalerweise wird das onCalculated Ereignis ausgelöst, wenn die Berechnung für eine Zelle abgeschlossen ist. Wenn die Berechnung jedoch einen vorübergehenden ausstehenden Wert (z. B. "#BUSY!") in der Zelle platziert, wird sie stattdessen ausgelöst, onCalculationBusy um anzuzeigen, dass sich der Zustand der Zelle geändert hat, obwohl die Berechnung des endgültigen Werts noch nicht abgeschlossen ist. Wenn ein nachfolgender Berechnungszyklus die Berechnung für diese Zelle abschließt, wird das onCalculated Ereignis ausgelöst.

Formelfunktionen wie JavaScript User-Defined Funktionen und =PY-Formeln können dieses Ereignis auslösen.

readonly onCalculationBusy: OfficeExtension.EventHandlers<Excel.WorksheetCalculationBusyEventArgs>;

Ereignistyp

Hinweise

API-Satz: ExcelApi BETA (NUR VORSCHAU)

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

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

Ereignistyp

Hinweise

API-Satz: ExcelApi 1.7

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

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

API-Satz: ExcelApi 1.10

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();
        });
    });
});

Tritt auf, wenn das Arbeitsblatt deaktiviert ist.

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

Ereignistyp

Hinweise

API-Satz: ExcelApi 1.7

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();
});

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)

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

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

Ereignistyp

Hinweise

API-Satz: ExcelApi 1.9

Tritt auf, wenn eine oder mehrere Formeln in diesem Arbeitsblatt geändert werden. Dieses Ereignis bezieht sich auf die Änderung der Formel selbst, nicht auf den Datenwert, der sich aus der Berechnung der Formel ergibt.

Das Ereignis wird nur ausgelöst, wenn die Zelle bereits eine Formel enthält. Der neue Zellwert enthält möglicherweise keine Formel. Dieses Ereignis wird nicht ausgelöst, wenn eine Formel in eine Zelle eingegeben wird, die zuvor keine Formel enthielt.

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

Tritt auf, wenn der Arbeitsblattname geändert wird.

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

Ereignistyp

Hinweise

API-Satz: ExcelApi 1.17

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

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

Ereignistyp

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

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

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

Ereignistyp

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();
});

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

Hinweise

API-Satz: ExcelApi 1.10

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();
        });
    });
});

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

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

Ereignistyp

Hinweise

API-Satz: ExcelApi 1.7

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();
});

Tritt auf, wenn eine mit der linken Maustaste geklickte/angetippte Aktion auf dem Arbeitsblatt ausgeführt wird. Dieses Ereignis wird beim Klicken in den folgenden Fällen nicht ausgelöst:

• Der Benutzer zieht die Maus, um die Mehrfachauswahl zu ermöglichen.

• Der Benutzer wählt eine Zelle in dem Modus aus, in dem Zellargumente für Formelbezüge ausgewählt sind.

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

Ereignistyp

Hinweise

API-Satz: ExcelApi 1.10

Beispiele

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    sheet.onSingleClicked.add((event) => {
        return Excel.run((context) => {
            console.log(`Click detected at ${event.address} (pixel offset from upper-left cell corner: ${event.offsetX}, ${event.offsetY})`);
            return context.sync();
        });
    });

    console.log("The worksheet click handler is registered.");

    await context.sync();
});

Tritt auf, wenn die Sichtbarkeit des Arbeitsblatts geändert wird.

readonly onVisibilityChanged: OfficeExtension.EventHandlers<Excel.WorksheetVisibilityChangedEventArgs>;

Ereignistyp

Hinweise

API-Satz: ExcelApi 1.17