Excel.Table class
Stellt eine Excel-Tabelle dar. Weitere Informationen zum Tabellenobjektmodell finden Sie unter Arbeiten mit Tabellen mithilfe der Excel-JavaScript-API.
- Extends
Hinweise
Eigenschaften
| columns | Stellt eine Auflistung aller Spalten in der Tabelle dar. |
| 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 die Tabelle umbenannt wird. |
| name | Der Name der Tabelle. Der Setname der Tabelle muss den Richtlinien entsprechen, die im Artikel Umbenennen einer Excel-Tabelle angegeben sind. |
| rows | Stellt eine Auflistung aller Zeilen in der Tabelle dar. |
| show |
Gibt an, ob die Kopfzeile sichtbar ist. Dieser Wert kann festgelegt werden, um die Kopfzeile anzuzeigen, oder sie zu entfernen. |
| show |
Gibt an, ob die Gesamtzeile sichtbar ist. Dieser Wert kann so festgelegt werden, dass die Ergebniszeile angezeigt oder ausgeblendet wird. |
| sort | Stellt die Sortierung für die Tabelle dar. |
| style | Konstanter Wert, der das Tabellenformat darstellt. Mögliche Werte sind: "TableStyleLight1" bis "TableStyleLight21", "TableStyleMedium1" bis "TableStyleMedium28", "TableStyleDark1" bis "TableStyleDark11". Es kann ebenfalls eine in der Arbeitsmappe vorhandene benutzerdefinierte Formatierung angegeben werden. |
| worksheet | Das Arbeitsblatt, das die aktuelle Tabelle enthält. |
Methoden
| clear |
Löscht alle Filter, die derzeit in der Tabelle verwendet werden. |
| convert |
Wandelt die Tabelle in einen normalen Bereich von Zellen um. Alle Daten werden beibehalten. |
| delete() | Löscht die Tabelle. |
| get |
Ruft das Bereichsobjekt ab, das mit dem Datenteil der Tabelle verknüpft ist. |
| get |
Ruft das Bereichsobjekt ab, das mit der Überschriftenzeile der Tabelle verknüpft ist. |
| get |
Ruft das Bereichsobjekt ab, das mit der gesamten Tabelle verknüpft ist. |
| get |
Ruft das Bereichsobjekt ab, das mit der Ergebniszeile der Tabelle verknüpft ist. |
| 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 " |
| reapply |
Wendet alle Filter erneut an, die derzeit in der Tabelle vorhanden sind. |
| 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 |
Details zur Eigenschaft
columns
Stellt eine Auflistung aller Spalten in der Tabelle dar.
readonly columns: Excel.TableColumnCollection;Eigenschaftswert
Hinweise
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
id
Gibt einen Wert zurück, der das Arbeitsblatt in einer bestimmten Arbeitsmappe eindeutig identifiziert. Der Wert des Bezeichners bleibt unverändert, auch wenn die Tabelle umbenannt wird.
readonly id: string;Eigenschaftswert
string
Hinweise
name
Der Name der Tabelle.
Der Setname der Tabelle muss den Richtlinien entsprechen, die im Artikel Umbenennen einer Excel-Tabelle angegeben sind.
name: string;Eigenschaftswert
string
Hinweise
rows
Stellt eine Auflistung aller Zeilen in der Tabelle dar.
readonly rows: Excel.TableRowCollection;Eigenschaftswert
Hinweise
showHeaders
Gibt an, ob die Kopfzeile sichtbar ist. Dieser Wert kann festgelegt werden, um die Kopfzeile anzuzeigen, oder sie zu entfernen.
showHeaders: boolean;Eigenschaftswert
boolean
Hinweise
showTotals
Gibt an, ob die Gesamtzeile sichtbar ist. Dieser Wert kann so festgelegt werden, dass die Ergebniszeile angezeigt oder ausgeblendet wird.
showTotals: boolean;Eigenschaftswert
boolean
Hinweise
sort
Stellt die Sortierung für die Tabelle dar.
readonly sort: Excel.TableSort;Eigenschaftswert
Hinweise
style
Konstanter Wert, der das Tabellenformat darstellt. Mögliche Werte sind: "TableStyleLight1" bis "TableStyleLight21", "TableStyleMedium1" bis "TableStyleMedium28", "TableStyleDark1" bis "TableStyleDark11". Es kann ebenfalls eine in der Arbeitsmappe vorhandene benutzerdefinierte Formatierung angegeben werden.
style: string;Eigenschaftswert
string
Hinweise
Beispiele
// Set table style.
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
table.name = 'Table1-Renamed';
table.showTotals = false;
table.style = 'TableStyleMedium2';
table.load('tableStyle');
await context.sync();
console.log(table.style);
});
worksheet
Das Arbeitsblatt, das die aktuelle Tabelle enthält.
readonly worksheet: Excel.Worksheet;Eigenschaftswert
Hinweise
Details zur Methode
clearFilters()
Löscht alle Filter, die derzeit in der Tabelle verwendet werden.
clearFilters(): void;Gibt zurück
void
Hinweise
convertToRange()
Wandelt die Tabelle in einen normalen Bereich von Zellen um. Alle Daten werden beibehalten.
convertToRange(): Excel.Range;Gibt zurück
Hinweise
Beispiele
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
table.convertToRange();
await context.sync();
});
delete()
Löscht die Tabelle.
delete(): void;Gibt zurück
void
Hinweise
Beispiele
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
table.delete();
await context.sync();
});
getDataBodyRange()
Ruft das Bereichsobjekt ab, das mit dem Datenteil der Tabelle verknüpft ist.
getDataBodyRange(): Excel.Range;Gibt zurück
Hinweise
Beispiele
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
const tableDataRange = table.getDataBodyRange();
tableDataRange.load('address')
await context.sync();
console.log(tableDataRange.address);
});
getHeaderRowRange()
Ruft das Bereichsobjekt ab, das mit der Überschriftenzeile der Tabelle verknüpft ist.
getHeaderRowRange(): Excel.Range;Gibt zurück
Hinweise
Beispiele
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
const tableHeaderRange = table.getHeaderRowRange();
tableHeaderRange.load('address');
await context.sync();
console.log(tableHeaderRange.address);
});
getRange()
Ruft das Bereichsobjekt ab, das mit der gesamten Tabelle verknüpft ist.
getRange(): Excel.Range;Gibt zurück
Hinweise
Beispiele
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
const tableRange = table.getRange();
tableRange.load('address');
await context.sync();
console.log(tableRange.address);
});
getTotalRowRange()
Ruft das Bereichsobjekt ab, das mit der Ergebniszeile der Tabelle verknüpft ist.
getTotalRowRange(): Excel.Range;Gibt zurück
Hinweise
Beispiele
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
const tableTotalsRange = table.getTotalRowRange();
tableTotalsRange.load('address');
await context.sync();
console.log(tableTotalsRange.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.TableLoadOptions): Excel.Table;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
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.Table;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 a table by name.
await Excel.run(async (context) => {
const tableName = 'Table1';
const table = context.workbook.tables.getItem(tableName);
table.load('id')
await context.sync();
console.log(table.id);
});
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.Table;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
reapplyFilters()
Wendet alle Filter erneut an, die derzeit in der Tabelle vorhanden sind.
reapplyFilters(): void;Gibt zurück
void
Hinweise
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.TableUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Excel.Interfaces.TableUpdateData
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
set(properties)
Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: Excel.Table): void;Parameter
- properties
- Excel.Table
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.Table-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.TableData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Excel.Interfaces.TableData;Gibt zurück
Office Add-ins
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für