Excel.TableRowCollection class
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
Hinweise
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, always |
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 |
| add |
Fügt der Tabelle mindestens eine Zeile hinzu. Das zurückgegebene Objekt ist die oberste Zeile der neu hinzugefügten Zeile(n). Im Gegensatz zu Beachten Sie, dass im Gegensatz zu Bereichen oder Spalten, die angepasst werden, wenn neue Zeilen oder Spalten vor ihnen hinzugefügt werden, ein |
| delete |
Löschen mehrerer Zeilen aus einer Tabelle. Diese Zeilen müssen nicht sequenziell sein. Diese Methode löst den |
| delete |
Löscht eine angegebene Anzahl von Zeilen aus einer Tabelle, beginnend bei einem bestimmten Index. Diese Methode löst den |
| get |
Ruft die Anzahl der Zeilen in der Tabelle ab. |
| get |
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 |
| 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 " |
| toJSON() | Überschreibt die JavaScript-Methode |
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
count
Gibt die Anzahl der Zeilen in der Tabelle zurück.
readonly count: number;Eigenschaftswert
number
Hinweise
items
Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
readonly items: Excel.TableRow[];Eigenschaftswert
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
Hinweise
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);
});
addAsJson(index, values, alwaysInsert)
Fügt der Tabelle mindestens eine Zeile hinzu. Das zurückgegebene Objekt ist die oberste Zeile der neu hinzugefügten Zeile(n). Im Gegensatz zu add()verwendet jeder addAsJson() Zellwerttyp, z. B. Bild- oder Entitätsdatentypen.
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.
addAsJson(index?: number, values?: CellValue[][], 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
-
Excel.CellValue[][]
Optional. Ein 2D-Array von Zellenwerten 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
Hinweise
deleteRows(rows)
Löschen mehrerer Zeilen aus einer Tabelle. Diese Zeilen müssen nicht sequenziell sein. Diese Methode löst den InvalidArgument Fehler aus, wenn eine ausgewählte Zeile bereits gelöscht wurde oder nicht vorhanden ist. Diese Methode löst den InsertDeleteConflict Fehler aus, wenn auf die Tabelle, für die die Methode aufgerufen wird, ein Filter angewendet wurde.
deleteRows(rows: number[] | TableRow[]): void;Parameter
- rows
-
number[] | Excel.TableRow[]
Ein Array von Zeilenindexnummern oder Zeilenobjekten, die aus der Tabelle gelöscht werden sollen.
Gibt zurück
void
Hinweise
deleteRowsAt(index, count)
Löscht eine angegebene Anzahl von Zeilen aus einer Tabelle, beginnend bei einem bestimmten Index. Diese Methode löst den InsertDeleteConflict Fehler aus, wenn auf die Tabelle, für die die Methode aufgerufen wird, ein Filter angewendet wurde.
deleteRowsAt(index: number, count?: number): void;Parameter
- index
-
number
Der Indexwert der zu löschenden Zeile. Hinweis: Zeilenindizes werden jedes Mal aktualisiert, wenn eine vorangehende Zeile in der Tabelle nach jedem Löschvorgang gelöscht wird. Stellen Sie sicher, dass sich der Index der Zeile, die Sie löschen möchten, zwischen dem Zeitpunkt, zu dem Sie den Wert bestimmt haben, und dem Zeitpunkt, zu dem Sie den Vorgang ausführen, nicht geändert hat.
- count
-
number
Anzahl der zu löschenden Zeilen. Standardmäßig wird eine einzelne Zeile gelöscht.
Gibt zurück
void
Hinweise
getCount()
Ruft die Anzahl der Zeilen in der Tabelle ab.
getCount(): OfficeExtension.ClientResult<number>;Gibt zurück
OfficeExtension.ClientResult<number>
Hinweise
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
Hinweise
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
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.TableRowCollection;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
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
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
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