Excel. Table class

Eigenschaften

autoFilter	Stellt das `AutoFilter` -Objekt der Tabelle dar.
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.
highlightFirstColumn	Gibt an, ob die erste Spalte eine spezielle Formatierung enthält.
highlightLastColumn	Gibt an, ob die letzte Spalte spezielle Formatierungen enthält.
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.
legacyId	Gibt eine numerische ID zurück.
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.
showBandedColumns	Gibt an, ob die Spalten eine gebänderte Formatierung aufweisen, in der ungerade Spalten anders hervorgehoben sind als gerade, um das Lesen der Tabelle zu vereinfachen.
showBandedRows	Gibt an, ob die Zeilen eine gebänderte Formatierung aufweisen, in der ungerade Zeilen anders hervorgehoben sind als gerade, um das Lesen der Tabelle zu vereinfachen.
showFilterButton	Gibt an, ob die Filterschaltflächen oben in jeder Spaltenüberschrift angezeigt werden. Diese Einstellung ist nur zulässig, wenn die Tabelle eine Kopfzeile enthält.
showHeaders	Gibt an, ob die Kopfzeile sichtbar ist. Dieser Wert kann festgelegt werden, um die Kopfzeile anzuzeigen, oder sie zu entfernen.
showTotals	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.
tableStyle	Die auf die Tabelle angewendete Formatvorlage.
worksheet	Das Arbeitsblatt, das die aktuelle Tabelle enthält.

Methoden

clearFilters()	Löscht alle Filter, die derzeit in der Tabelle verwendet werden.
clearStyle()	Ändert die Tabelle so, dass sie die Standard-Tabellenformatvorlage verwendet.
convertToRange()	Wandelt die Tabelle in einen normalen Bereich von Zellen um. Alle Daten werden beibehalten.
delete()	Löscht die Tabelle.
getDataBodyRange()	Ruft das Bereichsobjekt ab, das mit dem Datenteil der Tabelle verknüpft ist.
getHeaderRowRange()	Ruft das Bereichsobjekt ab, das mit der Überschriftenzeile der Tabelle verknüpft ist.
getRange()	Ruft das Bereichsobjekt ab, das mit der gesamten Tabelle verknüpft ist.
getTotalRowRange()	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 "`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.
reapplyFilters()	Wendet alle Filter erneut an, die derzeit in der Tabelle vorhanden sind.
resize(newRange)	Ändern Sie die Größe der Tabelle in den neuen Bereich. Der neue Bereich muss sich mit dem ursprünglichen Tabellenbereich überlappen, und die Kopfzeilen (oder der Anfang der Tabelle) müssen sich in derselben Zeile befinden.
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.
setStyle(style)	Legt die auf die Tabelle angewendete Formatvorlage fest.
toJSON()	Überschreibt die JavaScript-Methode `toJSON()` , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an `JSON.stringify()`übergeben wird. (`JSON.stringify`ruft 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.

Ereignisse

onChanged	Tritt auf, wenn sich Daten in Zellen in einer bestimmten Tabelle ändern.
onFiltered	Tritt auf, wenn ein Filter auf eine bestimmte Tabelle angewendet wird.
onSelectionChanged	Tritt auf, wenn sich die Auswahl für eine bestimmte Tabelle ändert.

Details zur Eigenschaft

autoFilter

Stellt das AutoFilter -Objekt der Tabelle dar.

readonly autoFilter: Excel.AutoFilter;

Eigenschaftswert

Excel.AutoFilter

Hinweise

[ API-Satz: ExcelApi 1.9 ]

columns

Stellt eine Auflistung aller Spalten in der Tabelle dar.

readonly columns: Excel.TableColumnCollection;

Eigenschaftswert

Excel.TableColumnCollection

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

Excel.RequestContext

highlightFirstColumn

Gibt an, ob die erste Spalte eine spezielle Formatierung enthält.

highlightFirstColumn: boolean;

Eigenschaftswert

boolean

Hinweise

highlightLastColumn

Gibt an, ob die letzte Spalte spezielle Formatierungen enthält.

highlightLastColumn: boolean;

Eigenschaftswert

boolean

Hinweise

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

legacyId

Gibt eine numerische ID zurück.

readonly legacyId: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.8 ]

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

Excel.TableRowCollection

Hinweise

showBandedColumns

Gibt an, ob die Spalten eine gebänderte Formatierung aufweisen, in der ungerade Spalten anders hervorgehoben sind als gerade, um das Lesen der Tabelle zu vereinfachen.

showBandedColumns: boolean;

Eigenschaftswert

boolean

Hinweise

showBandedRows

Gibt an, ob die Zeilen eine gebänderte Formatierung aufweisen, in der ungerade Zeilen anders hervorgehoben sind als gerade, um das Lesen der Tabelle zu vereinfachen.

showBandedRows: boolean;

Eigenschaftswert

boolean

Hinweise

showFilterButton

Gibt an, ob die Filterschaltflächen oben in jeder Spaltenüberschrift angezeigt werden. Diese Einstellung ist nur zulässig, wenn die Tabelle eine Kopfzeile enthält.

showFilterButton: boolean;

Eigenschaftswert

boolean

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

Excel.TableSort

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

tableStyle

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.

Die auf die Tabelle angewendete Formatvorlage.

readonly tableStyle: Excel.TableStyle;

Eigenschaftswert

Excel.TableStyle

Hinweise

worksheet

Das Arbeitsblatt, das die aktuelle Tabelle enthält.

readonly worksheet: Excel.Worksheet;

Eigenschaftswert

Excel.Worksheet

Hinweise

Details zur Methode

clearFilters()

Löscht alle Filter, die derzeit in der Tabelle verwendet werden.

clearFilters(): void;

Gibt zurück

void

Hinweise

clearStyle()

Hinweis

Ändert die Tabelle so, dass sie die Standard-Tabellenformatvorlage verwendet.

clearStyle(): 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

Excel.Range

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

Excel.Range

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

Excel.Range

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

Excel.Range

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

Excel.Range

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

options: Excel.Interfaces.TableLoadOptions

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

Gibt zurück

Excel.Table

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

Excel.Table

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

Excel.Table

reapplyFilters()

Wendet alle Filter erneut an, die derzeit in der Tabelle vorhanden sind.

reapplyFilters(): void;

Gibt zurück

void

Hinweise

resize(newRange)

Ändern Sie die Größe der Tabelle in den neuen Bereich. Der neue Bereich muss sich mit dem ursprünglichen Tabellenbereich überlappen, und die Kopfzeilen (oder der Anfang der Tabelle) müssen sich in derselben Zeile befinden.

resize(newRange: Range | string): void;

Parameter

newRange: Excel.Range | string

Das Bereichsobjekt oder die Bereichsadresse, die verwendet wird, um die neue Größe der Tabelle zu bestimmen.

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.13 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/resize-table.yaml

await Excel.run(async (context) => {
  // Retrieve the worksheet and a table on that worksheet.
  const sheet = context.workbook.worksheets.getItem("Sample");
  const expensesTable = sheet.tables.getItem("ExpensesTable");
  
  // Resize the table.
  expensesTable.resize("A1:D20");
  
  await context.sync();
});

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

setStyle(style)

Hinweis

Legt die auf die Tabelle angewendete Formatvorlage fest.

setStyle(style: string | TableStyle | BuiltInTableStyle): void;

Parameter

style: string | Excel.TableStyle | Excel.BuiltInTableStyle

Die Formatvorlage, die auf die Tabelle angewendet werden soll. Ein InvalidArgumentException wird ausgelöst, wenn eine Zeichenfolge angegeben wird, die nicht mit dem Namen einer Formatvorlage übereinstimmt.

Gibt zurück

void

Hinweise

OfficeExtension.EventHandlers<Excel.TableChangedEventArgs>

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

Excel.Interfaces.TableData

Details zum Ereignis

onChanged

Tritt auf, wenn sich Daten in Zellen in einer bestimmten Tabelle ändern.

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

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

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

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

onFiltered

Hinweis

Tritt auf, wenn ein Filter auf eine bestimmte Tabelle angewendet wird.

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

Ereignistyp

OfficeExtension.EventHandlers<Excel.TableFilteredEventArgs>

Hinweise