Freigeben über

Excel.TableCollection class

  • Referenz
Paket:
excel

Stellt eine Auflistung aller Tabellen dar, die Teil der Arbeitsmappe oder des Arbeitsblatts in Abhängigkeit davon dar, wie diese abgerufen wurde.

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

Gibt die Anzahl der Tabellen in der Arbeitsmappe zurück.
items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

Methoden

add(address, hasHeaders)

Erstellt eine neue Tabelle. Das Bereichsobjekt oder die Quelladresse bestimmt das Arbeitsblatt, unter dem die Tabelle hinzugefügt wird. Wenn die Tabelle nicht hinzugefügt werden kann (z. B. weil die Adresse ungültig ist oder sich die Tabelle mit einer anderen Tabelle überschneidet), wird ein Fehler ausgelöst.
getCount()

Ruft die Anzahl von Tabellen in der Auflistung ab.
getItem(key)

Ruft eine Tabelle anhand des Namens oder der ID ab.
getItemAt(index)

Ruft eine Tabelle anhand ihrer Position in der Auflistung ab.
getItemOrNullObject(key)

Ruft eine Tabelle anhand des Namens oder der ID ab. Wenn die Tabelle 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.
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.TableCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.TableCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

Ereignisse

onAdded

Tritt auf, wenn einer Arbeitsmappe eine neue Tabelle hinzugefügt wird.
onChanged

Tritt auf, wenn daten in einer Tabelle in einer Arbeitsmappe oder einem Arbeitsblatt geändert werden.
onDeleted

Tritt ein, wenn in einer Arbeitsmappe die angegebene Tabelle gelöscht wird.
onFiltered

Tritt auf, wenn ein Filter auf eine Beliebige Tabelle in einer Arbeitsmappe oder auf ein Arbeitsblatt angewendet wird.

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

count

Gibt die Anzahl der Tabellen in der Arbeitsmappe zurück.

readonly count: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.1 ]

items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: Excel.Table[];

Eigenschaftswert

Excel.Table[]

Details zur Methode

add(address, hasHeaders)

Erstellt eine neue Tabelle. Das Bereichsobjekt oder die Quelladresse bestimmt das Arbeitsblatt, unter dem die Tabelle hinzugefügt wird. Wenn die Tabelle nicht hinzugefügt werden kann (z. B. weil die Adresse ungültig ist oder sich die Tabelle mit einer anderen Tabelle überschneidet), wird ein Fehler ausgelöst.

add(address: Range | string, hasHeaders: boolean): Excel.Table;

Parameter

address

Excel.Range | string

Ein Range -Objekt oder eine Zeichenfolgenadresse oder ein Name des Bereichs, der die Datenquelle darstellt. Wenn die Adresse keinen Arbeitsblattnamen enthält, wird das aktuell aktive Blatt verwendet. [API-Satz: ExcelApi 1.1 / 1.3. Vor ExcelApi 1.3 muss dieser Parameter eine Zeichenfolge sein. Ab Excel-API 1.3 kann dieser Parameter ein Range-Objekt oder eine Zeichenfolge sein.]

hasHeaders

boolean

Ein boolescher Wert, der angibt, ob die importierten Daten Spaltenbeschriftungen aufweisen. Wenn die Quelle keine Header enthält (d. h. wenn diese Eigenschaft auf falsefestgelegt ist), generiert Excel automatisch eine Kopfzeile und verschiebt die Daten um eine Zeile nach unten.

Gibt zurück

Excel.Table

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => { 
    const table = context.workbook.tables.add('Sheet1!A1:E7', true);
    table.load('name');
    await context.sync();
    
    console.log(table.name);
});

getCount()

Ruft die Anzahl von Tabellen in der Auflistung ab.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

OfficeExtension.ClientResult<number>

Hinweise

[ API-Satz: ExcelApi 1.4 ]

getItem(key)

Ruft eine Tabelle anhand des Namens oder der ID ab.

getItem(key: string): Excel.Table;

Parameter

key

string

Name oder ID der abzurufenden Tabelle.

Gibt zurück

Excel.Table

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const table = context.workbook.tables.getItem(tableName);
    table.load('name');
    await context.sync();
    
    console.log(table.name);
});

getItemAt(index)

Ruft eine Tabelle anhand ihrer Position in der Auflistung ab.

getItemAt(index: number): Excel.Table;

Parameter

index

number

Index-Wert des abzurufenden Objekts. Nullindiziert.

Gibt zurück

Excel.Table

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => { 
    const table = context.workbook.tables.getItemAt(0);
    table.load('name');
    await context.sync();
    
    console.log(table.name);
});

getItemOrNullObject(key)

Ruft eine Tabelle anhand des Namens oder der ID ab. Wenn die Tabelle 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.Table;

Parameter

key

string

Name oder ID der abzurufenden Tabelle.

Gibt zurück

Excel.Table

Hinweise

[ API-Satz: ExcelApi 1.4 ]

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

Parameter

options

Excel.Interfaces.TableCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Gibt zurück

Excel.TableCollection

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

Parameter

propertyNames

string | string[]

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

Gibt zurück

Excel.TableCollection

Beispiele

// Get the number of tables.
await Excel.run(async (context) => { 
    const tables = context.workbook.tables;
    tables.load('count');
    await context.sync();
    
    console.log(tables.count);
});

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

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

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

toJSON(): Excel.Interfaces.TableCollectionData;

Gibt zurück

Excel.Interfaces.TableCollectionData

Details zum Ereignis

onAdded

Tritt auf, wenn einer Arbeitsmappe eine neue Tabelle hinzugefügt wird.

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

Ereignistyp

OfficeExtension.EventHandlers<Excel.TableAddedEventArgs>

Hinweise

[ API-Satz: ExcelApi 1.9 ]

onChanged

Tritt auf, wenn daten in einer Tabelle in einer Arbeitsmappe oder einem Arbeitsblatt geändert werden.

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

Ereignistyp

OfficeExtension.EventHandlers<Excel.TableChangedEventArgs>

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-tablecollection-changed.yaml

await Excel.run(async (context) => {
    let tables = context.workbook.tables;
    tables.onChanged.add(onChange);

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

onDeleted

Tritt ein, wenn in einer Arbeitsmappe die angegebene Tabelle gelöscht wird.

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

Ereignistyp

OfficeExtension.EventHandlers<Excel.TableDeletedEventArgs>

Hinweise

[ API-Satz: ExcelApi 1.9 ]

onFiltered

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Tritt auf, wenn ein Filter auf eine Beliebige Tabelle in einer Arbeitsmappe oder auf ein Arbeitsblatt angewendet wird.

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

Ereignistyp

OfficeExtension.EventHandlers<Excel.TableFilteredEventArgs>

Hinweise

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