Freigeben über

Excel.TableRowCollection class

  • Referenz
Paket:
excel

Stellt eine Auflistung aller Zeilen dar, die Teil der Tabelle sind.

Beachten Sie, dass im Gegensatz zu Bereichen oder Spalten, die angepasst werden, wenn neue Zeilen oder Spalten vor ihnen hinzugefügt werden, ein TableRow -Objekt die physische Position der Tabellenzeile darstellt, aber nicht die Daten. Das heißt, wenn die Daten sortiert oder neue Zeilen hinzugefügt werden, zeigt eine Tabellenzeile weiterhin auf den Index, für den sie erstellt wurde.

Extends
OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Eigenschaften

context

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

Gibt die Anzahl der Zeilen in der Tabelle zurück.
items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

Methoden

add(index, values, alwaysInsert)

Fügt der Tabelle mindestens eine Zeile hinzu. Das Rückgabeobjekt ist die oberste Zeile der neu hinzugefügten Zeilen.

Beachten Sie, dass im Gegensatz zu Bereichen oder Spalten, die angepasst werden, wenn neue Zeilen oder Spalten vor ihnen hinzugefügt werden, ein TableRow -Objekt die physische Position der Tabellenzeile darstellt, aber nicht die Daten. Das heißt, wenn die Daten sortiert oder neue Zeilen hinzugefügt werden, zeigt eine Tabellenzeile weiterhin auf den Index, für den sie erstellt wurde.
getCount()

Ruft die Anzahl der Zeilen in der Tabelle ab.
getItemAt(index)

Ruft eine Zeile anhand ihrer Position in der Auflistung ab.

Beachten Sie, dass im Gegensatz zu Bereichen oder Spalten, die angepasst werden, wenn neue Zeilen oder Spalten vor ihnen hinzugefügt werden, ein TableRow -Objekt die physische Position der Tabellenzeile darstellt, aber nicht die Daten. Das heißt, wenn die Daten sortiert oder neue Zeilen hinzugefügt werden, zeigt eine Tabellenzeile weiterhin auf den Index, für den sie erstellt wurde.
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.
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.TableRowCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.TableRowCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

Details zur Eigenschaft

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

count

Gibt die Anzahl der Zeilen in der Tabelle zurück.

readonly count: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.1 ]

items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: Excel.TableRow[];

Eigenschaftswert

Excel.TableRow[]

Details zur Methode

add(index, values, alwaysInsert)

Fügt der Tabelle mindestens eine Zeile hinzu. Das Rückgabeobjekt ist die oberste Zeile der neu hinzugefügten Zeilen.

Beachten Sie, dass im Gegensatz zu Bereichen oder Spalten, die angepasst werden, wenn neue Zeilen oder Spalten vor ihnen hinzugefügt werden, ein TableRow -Objekt die physische Position der Tabellenzeile darstellt, aber nicht die Daten. Das heißt, wenn die Daten sortiert oder neue Zeilen hinzugefügt werden, zeigt eine Tabellenzeile weiterhin auf den Index, für den sie erstellt wurde.

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

Parameter

index

number

Optional. Gibt die relative Position der neuen Zeile an. Bei NULL oder -1 erfolgt die Erweiterung am Ende. Alle Zeilen unterhalb der eingefügten Zeile werden nach unten verschoben. Nullindiziert.

values

Array<Array<boolean | string | number>> | boolean | string | number

Optional. Ein 2D-Array unformatierter Werte der Tabellenzeile.

alwaysInsert

boolean

Optional. Gibt an, ob die neuen Zeilen in die Tabelle eingefügt werden, wenn neue Zeilen hinzugefügt werden. Gibt truean, dass die neuen Zeilen in die Tabelle eingefügt werden. Gibt falsean, werden die neuen Zeilen unterhalb der Tabelle hinzugefügt. Der Standardwert ist true.

Gibt zurück

Excel.TableRow

Hinweise

[ API-Satz: ExcelApi 1.1 zum Hinzufügen einer einzelnen Zeile; 1.4 ermöglicht das Hinzufügen mehrerer Zeilen; 1.15 für das Hinzufügen von alwaysInsert Parametern. ]

Beispiele

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

getCount()

Ruft die Anzahl der Zeilen in der Tabelle ab.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

OfficeExtension.ClientResult<number>

Hinweise

[ API-Satz: ExcelApi 1.4 ]

getItemAt(index)

Ruft eine Zeile anhand ihrer Position in der Auflistung ab.

Beachten Sie, dass im Gegensatz zu Bereichen oder Spalten, die angepasst werden, wenn neue Zeilen oder Spalten vor ihnen hinzugefügt werden, ein TableRow -Objekt die physische Position der Tabellenzeile darstellt, aber nicht die Daten. Das heißt, wenn die Daten sortiert oder neue Zeilen hinzugefügt werden, zeigt eine Tabellenzeile weiterhin auf den Index, für den sie erstellt wurde.

getItemAt(index: number): Excel.TableRow;

Parameter

index

number

Index-Wert des abzurufenden Objekts. Nullindiziert.

Gibt zurück

Excel.TableRow

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

await Excel.run(async (context) => {
    const tablerow = context.workbook.tables.getItem('Table1').rows.getItemAt(0);
    tablerow.load('values');
    await context.sync();
    console.log(tablerow.values);
});

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

Parameter

options

Excel.Interfaces.TableRowCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Gibt zurück

Excel.TableRowCollection

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

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Excel.TableRowCollection

Beispiele

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

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

Parameter

propertyNamesAndPaths
OfficeExtension.LoadOption

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.TableRowCollection

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

toJSON(): Excel.Interfaces.TableRowCollectionData;

Gibt zurück

Excel.Interfaces.TableRowCollectionData