Excel.TableColumnCollection class

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

context: RequestContext;

Eigenschaftswert

Gibt die Anzahl der Spalten in der Tabelle an.

readonly count: number;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: Excel.TableColumn[];

Eigenschaftswert

Fügt der Tabelle eine neue Spalte hinzu.

add(index?: number, values?: Array<Array<boolean | string | number>> | boolean | string | number, name?: string): Excel.TableColumn;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.1 erfordert einen Index, der kleiner als die Gesamtspaltenanzahl ist; 1.4 lässt den Index optional (NULL oder -1) zu und fügt eine Spalte am Ende an; 1.4 lässt den Namensparameter zum Zeitpunkt der Erstellung zu. ]

Beispiele

await Excel.run(async (context) => { 
    const tables = context.workbook.tables;
    const values = [["Sample"], ["Values"], ["For"], ["New"], ["Column"]];
    const column = tables.getItem("Table1").columns.add(null, values);
    column.load('name');
    await context.sync();
    
    console.log(column.name);
});

Fügt der Tabelle eine neue Spalte hinzu. Im Gegensatz zu add()verwendet jeder addAsJson() Zellwerttyp, z. B. Bild- oder Entitätsdatentypen.

addAsJson(index?: number, values?: CellValue[][], name?: string): Excel.TableColumn;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.16 ]

Ruft die Anzahl der Spalten in der Tabelle ab.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.4 ]

Ruft ein Spaltenobjekt nach Name oder ID ab.

getItem(key: number | string): Excel.TableColumn;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

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

Ruft eine Spalte anhand ihrer Position in der Auflistung ab.

getItemAt(index: number): Excel.TableColumn;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => { 
    const tableColumn = context.workbook.tables.getItem['Table1'].columns.getItemAt(0);
    tableColumn.load('name');
    await context.sync();
    console.log(tableColumn.name);
});

Ruft ein Spaltenobjekt nach Name oder ID ab. Wenn die Spalte 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: number | string): Excel.TableColumn;

Parameter

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.4 ]

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

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

Parameter

Gibt zurück

Beispiele

await Excel.run(async (context) => { 
    const tableColumns = context.workbook.tables.getItem('Table1').columns;
    tableColumns.load('items');
    await context.sync();
    
    console.log("tableColumns Count: " + tableColumns.count);
    for (let i = 0; i < tableColumns.items.length; i++) {
        console.log(tableColumns.items[i].name);
    }
});

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

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

toJSON(): Excel.Interfaces.TableColumnCollectionData;

Gibt zurück