Excel.TableCollection class
Stellt eine Auflistung aller Tabellen dar, die Teil der Arbeitsmappe oder des Arbeitsblatts in Abhängigkeit davon dar, wie diese abgerufen wurde.
- Extends
Hinweise
Verwendet von
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml
// Add checkboxes to the table.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getActiveWorksheet();
// Get the second column in the table, without the header.
const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();
// Change the boolean values to checkboxes.
range.control = {
type: Excel.CellControlType.checkbox
};
await context.sync();
});
Eigenschaften
| context | Der dem Objekt zugeordnete Anforderungskontext. 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, has |
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 überschneiden würde), wird ein Fehler ausgelöst. |
| get |
Ruft die Anzahl von Tabellen in der Auflistung ab. |
| get |
Ruft eine Tabelle anhand des Namens oder der ID ab. |
| get |
Ruft eine Tabelle anhand ihrer Position in der Auflistung ab. |
| get |
Ruft eine Tabelle anhand des Namens oder der ID ab. Wenn die Tabelle nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| toJSON() | Überschreibt die JavaScript-Methode |
Ereignisse
| on |
Tritt auf, wenn eine neue Tabelle in einer Arbeitsmappe hinzugefügt wird. |
| on |
Tritt auf, wenn sich Daten in einer beliebigen Tabelle in einer Arbeitsmappe oder auf einem Arbeitsblatt ändern. |
| on |
Tritt ein, wenn in einer Arbeitsmappe die angegebene Tabelle gelöscht wird. |
| on |
Tritt auf, wenn ein Filter auf eine beliebige Tabelle in einer Arbeitsmappe oder auf einem Arbeitsblatt angewendet wird. |
Details zur Eigenschaft
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
count
Gibt die Anzahl der Tabellen in der Arbeitsmappe zurück.
readonly count: number;Eigenschaftswert
number
Hinweise
items
Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
readonly items: Excel.Table[];Eigenschaftswert
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 überschneiden würde), wird ein Fehler ausgelöst.
add(address: Range | string, hasHeaders: boolean): Excel.Table;Parameter
- address
-
Excel.Range | string
Ein Range Objekt, eine Zeichenfolge, die Adresse oder der 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 zu importierenden Daten Spaltenbeschriftungen haben. Wenn die Quelle keine Überschriften 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
Hinweise
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
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
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml
// Remove checkboxes from the table.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getActiveWorksheet();
// Get the second column in the table, without the header.
const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange();
// Change the checkboxes back to boolean values.
range.control = {
type: Excel.CellControlType.empty
};
await context.sync();
});
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
Hinweise
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 festgelegt ist true. 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
Hinweise
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
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
Gibt zurück
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
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 Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
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 sie ü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 Sammlung enthält.
toJSON(): Excel.Interfaces.TableCollectionData;Gibt zurück
Details zum Ereignis
onAdded
Tritt auf, wenn eine neue Tabelle in einer Arbeitsmappe hinzugefügt wird.
readonly onAdded: OfficeExtension.EventHandlers<Excel.TableAddedEventArgs>;Ereignistyp
Hinweise
onChanged
Tritt auf, wenn sich Daten in einer beliebigen Tabelle in einer Arbeitsmappe oder auf einem Arbeitsblatt ändern.
readonly onChanged: OfficeExtension.EventHandlers<Excel.TableChangedEventArgs>;Ereignistyp
Hinweise
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
Hinweise
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 einem Arbeitsblatt angewendet wird.
readonly onFiltered: OfficeExtension.EventHandlers<Excel.TableFilteredEventArgs>;