Excel.Table class

Stellt eine Auflistung aller Spalten in der Tabelle dar.

readonly columns: Excel.TableColumnCollection;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

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

context: RequestContext;

Eigenschaftswert

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

highlightFirstColumn: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.3

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

highlightLastColumn: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.3

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

Hinweise

API-Satz: ExcelApi 1.1

Der Name der Tabelle.

Der festgelegte Name der Tabelle muss den Richtlinien entsprechen, die im Artikel Umbenennen einer Excel-Tabelle angegeben sind.

name: string;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Beispiele

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable: Excel.Table = sheet.tables.add('A1:E7', true);
    expensesTable.name = "ExpensesTable";

    await context.sync();
});

Stellt eine Auflistung aller Zeilen in der Tabelle dar.

readonly rows: Excel.TableRowCollection;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/46-table/add-rows-and-columns-to-a-table.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable: Excel.Table = sheet.tables.getItem("ExpensesTable");

    expensesTable.rows.add(null, [
    ["1/16/2017", "THE PHONE COMPANY", "Communications", "$120"],
    ["1/20/2017", "NORTHWIND ELECTRIC CARS", "Transportation", "$142"],
    ["1/20/2017", "BEST FOR YOU ORGANICS COMPANY", "Groceries", "$27"]
    ]);

    sheet.getUsedRange().format.autofitColumns();
    sheet.getUsedRange().format.autofitRows();

    await context.sync();
});

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

showBandedColumns: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.3

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

showBandedRows: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.3

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

showFilterButton: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.3

Gibt an, ob die Kopfzeile sichtbar ist. Dieser Wert kann festgelegt werden, um die Kopfzeile anzuzeigen, oder sie zu entfernen.

showHeaders: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Gibt an, ob die Ergebniszeile sichtbar ist. Dieser Wert kann so festgelegt werden, dass die Ergebniszeile angezeigt oder ausgeblendet wird.

showTotals: boolean;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.1

Stellt die Sortierung für die Tabelle dar.

readonly sort: Excel.TableSort;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.2

Beispiele

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable: Excel.Table = sheet.tables.getItem("ExpensesTable");

    // Sort the table by the "Amount" column.
    const sortFields = [
        {
        key: 3,
        ascending: false
        }
    ];
    expensesTable.sort.apply(sortFields);

    await context.sync();
});

Konstanter Wert, der die Tabellenformatvorlage 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

Hinweise

API-Satz: ExcelApi 1.1

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

Das Arbeitsblatt, das die aktuelle Tabelle enthält.

readonly worksheet: Excel.Worksheet;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.2

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

clearFilters(): void;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.2

Beispiele

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

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const expensesTable = sheet.tables.getItem("ExpensesTable");
    expensesTable.clearFilters();
    await context.sync();
   });

Wandelt die Tabelle in einen normalen Bereich von Zellen um. Alle Daten werden beibehalten.

convertToRange(): Excel.Range;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.2

Beispiele

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

Löscht die Tabelle.

delete(): void;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.1

Beispiele

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

Ruft das Bereichsobjekt ab, das mit dem Datenteil der Tabelle verknüpft ist.

getDataBodyRange(): Excel.Range;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.1

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

Ruft das Bereichsobjekt ab, das mit der Überschriftenzeile der Tabelle verknüpft ist.

getHeaderRowRange(): Excel.Range;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.1

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

Ruft das Bereichsobjekt ab, das mit der gesamten Tabelle verknüpft ist.

getRange(): Excel.Range;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.1

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

Ruft das Bereichsobjekt ab, das mit der Ergebniszeile der Tabelle verknüpft ist.

getTotalRowRange(): Excel.Range;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.1

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

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

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

Parameter

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

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

Gibt zurück

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

reapplyFilters(): void;

Gibt zurück

Hinweise

API-Satz: ExcelApi 1.2

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

Gibt zurück

Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.Table): void;

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 sie übergeben wird.) Während das ursprüngliche Excel.Table Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.TableData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Excel.Interfaces.TableData;

Gibt zurück

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

Tritt auf, wenn sich die Auswahl in einer bestimmten Tabelle ändert.

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

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.onSelectionChanged.add(onSelectionChange);

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