Excel.Worksheet class

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

readonly charts: Excel.ChartCollection;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-create-several-charts.yaml

await Excel.run(async (context) => {
  let sheet = context.workbook.worksheets.getItem("Sample");
  let salesTable = sheet.tables.getItem("SalesTable");

  let dataRange = sheet.getRange("A1:E7");

  // Create an XY scatter chart.
  let chart = sheet.charts.add(Excel.ChartType.xyscatter, dataRange, "Auto");
  chart.title.text = "Bicycle Parts Quarterly Sales";
  chart.setPosition("A36", "F48");

  await context.sync();
});

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

context: RequestContext;

Eigenschaftswert

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

Beispiele

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    sheet.freezePanes.unfreeze();

    await context.sync();
});

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

Beispiele

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

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

    currentSheet.name = await uniqueWorksheetName(context);

    await context.sync();
    console.log(`Renamed worksheet to "${currentSheet.name}"`);
});

Auflistung von Namen im Bereich des aktuellen Arbeitsblatts.

readonly names: Excel.NamedItemCollection;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.4

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 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 die Sammlung von Tabellen zurück, die Teil des Arbeitsblatts sind.

readonly tables: Excel.TableCollection;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

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.

Beispiele

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("VisibilitySample");

    // Load the visibility property so it can be read after context.sync().
    sheet.load("name, visibility");

    await context.sync();

    console.log(`The visibility of worksheet "${sheet.name}" is ${sheet.visibility}.`);
});

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

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

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

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

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

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