Excel.WorksheetCollection class

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

context: RequestContext;

Eigenschaftswert

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: Excel.Worksheet[];

Eigenschaftswert

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

Gibt zurück

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

Fügt die angegebenen Arbeitsblätter einer Arbeitsmappe in die aktuelle Arbeitsmappe ein.

Hinweis*: Diese API wird derzeit nur für Office unter Windows und Mac unterstützt. Und es ist veraltet, bitte verwenden Sie Workbook.insertWorksheetFromBase64 stattdessen.

addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Worksheet | string): OfficeExtension.ClientResult<string[]>;

Parameter

Gibt zurück

Ein Array von IDs, die jedem neu eingefügten Arbeitsblatt entsprechen.

Hinweise

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

Fügt die angegebenen Arbeitsblätter einer Arbeitsmappe in die aktuelle Arbeitsmappe ein.

Hinweis*: Diese API wird derzeit nur für Office unter Windows und Mac unterstützt. Und es ist veraltet, bitte verwenden Sie Workbook.insertWorksheetFromBase64 stattdessen.

addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionTypeString?: "None" | "Before" | "After" | "Beginning" | "End", relativeTo?: Worksheet | string): OfficeExtension.ClientResult<string[]>;

Parameter

Gibt zurück

Ein Array von IDs, die jedem neu eingefügten Arbeitsblatt entsprechen.

Hinweise

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

Ruft das derzeit aktive Arbeitsblatt in der Arbeitsmappe ab.

getActiveWorksheet(): Excel.Worksheet;

Gibt zurück

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

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

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.4 ]

Ruft das erste Arbeitsblatt in der Sammlung ab.

getFirst(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 Arbeitsblattobjekt mithilfe des Namens oder der ID ab.

getItem(key: string): Excel.Worksheet;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.1 ]

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

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.4 ]

Ruft das letzte Arbeitsblatt in der Sammlung ab.

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

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

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

Parameter

Gibt zurück

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

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

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

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

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

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

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

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

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

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

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

Ereignistyp

Hinweise

[ API-Satz: ExcelApi 1.8 ]

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

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

Ereignistyp

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

Hinweise

[ API-Satz: ExcelApi 1.10 ]

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

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

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

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

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

Ereignistyp

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Tritt ein, wenn ein Filter eines beliebigen Arbeitsblatts in der Arbeitsmappe angewendet wird.

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

Ereignistyp

Hinweise

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

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

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

Ereignistyp

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Tritt auf, wenn eine oder mehrere Formeln in einem Arbeitsblatt dieser Auflistung 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 ]

Tritt auf, wenn ein Arbeitsblatt innerhalb einer Arbeitsmappe verschoben wird. Dieses Ereignis wird nur ausgelöst, wenn ein Arbeitsblatt direkt innerhalb einer Arbeitsmappe verschoben wird. Dieses Ereignis wird nicht ausgelöst, wenn die Position eines Arbeitsblatts indirekt geändert wird, z. B. wenn ein neues Arbeitsblatt eingefügt wird, und bewirkt, dass vorhandene Arbeitsblätter die Position ändern.

readonly onMoved: OfficeExtension.EventHandlers<Excel.WorksheetMovedEventArgs>;

Ereignistyp

Hinweise

[ API-Satz: ExcelApi 1.17 ]

Tritt auf, wenn der Name des Arbeitsblatts in der Arbeitsblattauflistung 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 ]

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

Hinweise

[ API-Satz: ExcelApi 1.11 ]

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 ]

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

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

Ereignistyp

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

Hinweise

[ API-Satz: ExcelApi 1.10 ]

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

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

Ereignistyp

Hinweise

[ API-Satz: ExcelApi 1.17 ]