Freigeben über

Excel.WorksheetCollection class

  • Referenz
Paket:
excel

Stellt eine Auflistung der Arbeitsblattobjekte dar, die Teil der Arbeitsmappe sind.

Extends
OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Eigenschaften

context

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

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

Methoden

add(name)

Fügt der Arbeitsmappe ein neues Arbeitsblatt hinzu. Das Arbeitsblatt wird automatisch am Ende der vorhandenen Arbeitsblättern hinzugefügt. Wenn Sie das neu hinzugefügte Arbeitsblatt aktivieren möchten, rufen Sie .activate() darauf auf.
getActiveWorksheet()

Ruft das derzeit aktive Arbeitsblatt in der Arbeitsmappe ab.
getCount(visibleOnly)

Ruft die Anzahl von Arbeitsblättern in der Auflistung ab.
getFirst(visibleOnly)

Ruft das erste Arbeitsblatt in der Sammlung ab.
getItem(key)

Ruft das Arbeitsblattobjekt mithilfe des Namens oder der ID ab.
getItemOrNullObject(key)

Ruft das Arbeitsblattobjekt mithilfe des Namens oder der ID ab. Wenn das Arbeitsblatt nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getLast(visibleOnly)

Ruft das letzte Arbeitsblatt in der Sammlung ab.
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.
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.WorksheetCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.WorksheetCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

Ereignisse

onActivated

Tritt auf, wenn ein Arbeitsblatt in der Arbeitsmappe aktiviert wird.
onAdded

Tritt auf, wenn der Arbeitsmappe ein neues Arbeitsblatt hinzugefügt wird.
onCalculated

Tritt auf, wenn ein Arbeitsblatt in der Arbeitsmappe berechnet wird.
onChanged

Tritt ein, wenn eines der Arbeitsblätter in der Arbeitsmappe geändert wird.
onColumnSorted

Tritt auf, wenn eine oder mehrere Spalten sortiert wurden. Dies geschieht, wenn Spalten von links nach rechts sortiert werden.
onDeactivated

Tritt auf, wenn ein Arbeitsblatt in der Arbeitsmappe deaktiviert wird.
onDeleted

Tritt auf, wenn ein Arbeitsblatt aus der Arbeitsmappe gelöscht wird.
onFormatChanged

Tritt auf, wenn für ein Arbeitsblatt in der Arbeitsmappe ein Format geändert wurde.
onRowSorted

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

Tritt ein, wenn sich die Auswahl auf einem beliebigen Arbeitsblatt ändert.
onSingleClicked

Tritt auf, wenn in der Arbeitsblattauflistung ein Vorgang mit linksklickt/getippt wird. Dieses Ereignis wird beim Klicken in den folgenden Fällen nicht ausgelöst: - 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.

Details zur Eigenschaft

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

items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: Excel.Worksheet[];

Eigenschaftswert

Excel.Worksheet[]

Details zur Methode

add(name)

Fügt der Arbeitsmappe ein neues Arbeitsblatt hinzu. Das Arbeitsblatt wird automatisch am Ende der vorhandenen Arbeitsblättern hinzugefügt. Wenn Sie das neu hinzugefügte Arbeitsblatt aktivieren möchten, rufen Sie .activate() darauf auf.

add(name?: string): Excel.Worksheet;

Parameter

name

string

Optional. Der Name des hinzuzufügenden Arbeitsblatts. Falls angegeben, sollte der Name eindeutig sein. Falls nicht angegeben, bestimmt Excel den Namen des neuen Arbeitsblatts.

Gibt zurück

Excel.Worksheet

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => { 
    const wSheetName = 'Sample Name';
    const worksheet = context.workbook.worksheets.add(wSheetName);
    worksheet.load('name');
    await context.sync();
    
    console.log(worksheet.name);
});

getActiveWorksheet()

Ruft das derzeit aktive Arbeitsblatt in der Arbeitsmappe ab.

getActiveWorksheet(): Excel.Worksheet;

Gibt zurück

Excel.Worksheet

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => {  
    const activeWorksheet = context.workbook.worksheets.getActiveWorksheet();
    activeWorksheet.load('name');
    await context.sync();
    console.log(activeWorksheet.name);
});

getCount(visibleOnly)

Ruft die Anzahl von Arbeitsblättern in der Auflistung ab.

getCount(visibleOnly?: boolean): OfficeExtension.ClientResult<number>;

Parameter

visibleOnly

boolean

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

Gibt zurück

OfficeExtension.ClientResult<number>

Hinweise

[ API-Satz: ExcelApi 1.4 ]

getFirst(visibleOnly)

Ruft das erste Arbeitsblatt in der Sammlung ab.

getFirst(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

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

getItem(key)

Ruft das Arbeitsblattobjekt mithilfe des Namens oder der ID ab.

getItem(key: string): Excel.Worksheet;

Parameter

key

string

Der Name oder die ID des Arbeitsblatts.

Gibt zurück

Excel.Worksheet

Hinweise

[ API-Satz: ExcelApi 1.1 ]

getItemOrNullObject(key)

Ruft das Arbeitsblattobjekt mithilfe des Namens oder der ID ab. Wenn das Arbeitsblatt nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getItemOrNullObject(key: string): Excel.Worksheet;

Parameter

key

string

Der Name oder die ID des Arbeitsblatts.

Gibt zurück

Excel.Worksheet

Hinweise

[ API-Satz: ExcelApi 1.4 ]

getLast(visibleOnly)

Ruft das letzte Arbeitsblatt in der Sammlung ab.

getLast(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

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

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.WorksheetCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCollection;

Parameter

options

Excel.Interfaces.WorksheetCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Gibt zurück

Excel.WorksheetCollection

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.WorksheetCollection;

Parameter

propertyNames

string | string[]

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

Gibt zurück

Excel.WorksheetCollection

Beispiele

await Excel.run(async (context) => { 
    const worksheets = context.workbook.worksheets;
    worksheets.load('items');
    await context.sync();
    
    for (let i = 0; i < worksheets.items.length; i++) {
        console.log(worksheets.items[i].name);
    }
});

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?: OfficeExtension.LoadOption): Excel.WorksheetCollection;

Parameter

propertyNamesAndPaths
OfficeExtension.LoadOption

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.WorksheetCollection

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.WorksheetCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.WorksheetCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

toJSON(): Excel.Interfaces.WorksheetCollectionData;

Gibt zurück

Excel.Interfaces.WorksheetCollectionData

Details zum Ereignis

onActivated

Tritt auf, wenn ein Arbeitsblatt in der Arbeitsmappe aktiviert wird.

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

Ereignistyp

OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>

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-workbook-and-worksheet-collection.yaml

await Excel.run(async (context) => {
    let sheets = context.workbook.worksheets;
    sheets.onActivated.add(onActivate);

    await context.sync();
    console.log("A handler has been registered for the OnActivate event.");
});

onAdded

Tritt auf, wenn der Arbeitsmappe ein neues Arbeitsblatt hinzugefügt wird.

readonly onAdded: OfficeExtension.EventHandlers<Excel.WorksheetAddedEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Excel.WorksheetAddedEventArgs>

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-workbook-and-worksheet-collection.yaml

await Excel.run(async (context) => {
    let sheet = context.workbook.worksheets;
    sheet.onAdded.add(onWorksheetAdd);

    await context.sync();
    console.log("A handler has been registered for the OnAdded event.");
});

onCalculated

Tritt auf, wenn ein Arbeitsblatt in der Arbeitsmappe berechnet wird.

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

Ereignistyp

OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>

Hinweise

[ API-Satz: ExcelApi 1.8 ]

onChanged

Tritt ein, wenn eines der Arbeitsblätter in der Arbeitsmappe geändert wird.

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

Ereignistyp

OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>

Hinweise

[ API-Satz: ExcelApi 1.9 ]

onColumnSorted

Tritt auf, wenn eine oder mehrere Spalten sortiert wurden. Dies geschieht, wenn Spalten von links nach rechts sortiert werden.

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

Ereignistyp

OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>

Hinweise

[ API-Satz: ExcelApi 1.10 ]

onDeactivated

Tritt auf, wenn ein Arbeitsblatt in der Arbeitsmappe deaktiviert wird.

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

Ereignistyp

OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>

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-workbook-and-worksheet-collection.yaml

await Excel.run(async (context) => {
    let sheets = context.workbook.worksheets;
    sheets.onDeactivated.add(onDeactivate);

    await context.sync();
    console.log("A handler has been registered for the OnDeactivate event.");
});

onDeleted

Tritt auf, wenn ein Arbeitsblatt aus der Arbeitsmappe gelöscht wird.

readonly onDeleted: OfficeExtension.EventHandlers<Excel.WorksheetDeletedEventArgs>;

Ereignistyp

OfficeExtension.EventHandlers<Excel.WorksheetDeletedEventArgs>

Hinweise

[ API-Satz: ExcelApi 1.7 ]

onFormatChanged

Tritt auf, wenn für ein Arbeitsblatt in der Arbeitsmappe ein Format geändert wurde.

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

Ereignistyp

OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

[ API-Satz: ExcelApi 1.10 ]

onSelectionChanged

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

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

Ereignistyp

OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>

Hinweise

[ API-Satz: ExcelApi 1.9 ]

onSingleClicked

Tritt auf, wenn in der Arbeitsblattauflistung ein Vorgang mit linksklickt/getippt wird. Dieses Ereignis wird beim Klicken in den folgenden Fällen nicht ausgelöst: - 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

OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>

Hinweise

[ API-Satz: ExcelApi 1.10 ]