Excel.Worksheet class

  • Referenz
Paket:
excel

Ein Excel-Arbeitsblatt ist ein Raster von Zellen. Sie kann Daten, Tabellen, Diagramme usw. enthalten. Weitere Informationen zum Arbeitsblattobjektmodell finden Sie unter Arbeiten mit Arbeitsblättern mithilfe der Excel-JavaScript-API.

Extends
OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Eigenschaften

charts

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

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
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.
position

Die nullbasiert Position des Arbeitsblatts in der Arbeitsmappe.
protection

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

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

Die Sichtbarkeit des Arbeitsblatts.

Methoden

activate()

Aktivieren Sie das Arbeitsblatt in der Excel-Benutzeroberfläche.
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.
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.
getRange(address)

Ruft das Range -Objekt ab, das einen einzelnen rechteckigen Zellblock darstellt, der durch die Adresse oder den Namen angegeben wird.
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).
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.
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.
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.

Details zur Eigenschaft

charts

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

readonly charts: Excel.ChartCollection;

Eigenschaftswert

Excel.ChartCollection

Hinweise

[ API-Satz: ExcelApi 1.1 ]

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

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

[ API-Satz: ExcelApi 1.1 ]

name

Der Anzeigename des Arbeitsblatts.

name: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.1 ]

position

Die nullbasiert Position des Arbeitsblatts in der Arbeitsmappe.

position: number;

Eigenschaftswert

number

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

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

tables

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

readonly tables: Excel.TableCollection;

Eigenschaftswert

Excel.TableCollection

Hinweise

[ API-Satz: ExcelApi 1.1 ]

visibility

Die Sichtbarkeit des Arbeitsblatts.

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

Eigenschaftswert

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

Hinweise

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

Details zur Methode

activate()

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

activate(): void;

Gibt zurück

void

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

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

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

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

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

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

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

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

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

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

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

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