Excel.TableRow class

Paket:: excel

Stellt eine Zeile in einer Tabelle dar.

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

Extends: OfficeExtension.ClientObject

Hinweise

API-Satz: ExcelApi 1.1

Verwendet von

Excel.TableRowCollection: hinzufügen, addAsJson, deleteRows, getItemAt, Elemente

Eigenschaften

context	Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
index	Gibt die Indexnummer der Zeile in der Zeilenauflistung der Tabelle zurück. Nullindiziert.
values	Stellt die Rohwerte des angegebenen Bereichs dar. Bei den zurückgegebenen Daten kann es sich um Zeichenfolgen, Zahlen oder boolesche Werte handeln. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück. Wenn der zurückgegebene Wert mit einem Pluszeichen ("+"), einem Minuszeichen ("-") oder einem Gleichheitszeichen ("=") beginnt, interpretiert Excel diesen Wert als Formel.
valuesAsJson	Eine JSON-Darstellung der Werte in den Zellen in dieser Tabellenzeile. Im Gegensatz `TableRow.values`zu unterstützt unterstützt dies alle Datentypen, `TableRow.valuesAsJson` die sich in einer Zelle befinden können. Beispiele sind neben den standardmäßigen booleschen, numerischen und Zeichenfolgenwerten auch formatierte Zahlenwerte und Webbilder. Von dieser API zurückgegebene Daten stimmen immer mit dem Gebietsschema en-US überein. Um Daten im Anzeigegebietsschema des Benutzers abzurufen, verwenden Sie `TableRow.valuesAsJsonLocal`.
valuesAsJsonLocal	Eine JSON-Darstellung der Werte in den Zellen in dieser Tabellenzeile. Im Gegensatz `TableRow.values`zu unterstützt unterstützt dies alle Datentypen, `TableRow.valuesAsJsonLocal` die sich in einer Zelle befinden können. Beispiele sind neben den standardmäßigen booleschen, numerischen und Zeichenfolgenwerten auch formatierte Zahlenwerte und Webbilder. Die von dieser API zurückgegebenen Daten entsprechen immer dem Anzeigegebietsschema des Benutzers. Um Daten unabhängig vom Gebietsschema abzurufen, verwenden Sie `TableRow.valuesAsJson`.

Methoden

delete()	Löscht die Zeile aus der Tabelle.
getRange()	Ruft das Bereichsobjekt ab, das mit der gesamten Zeile 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.
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.
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 sie übergeben wird.) Während das ursprüngliche `Excel.TableRow` Objekt ein API-Objekt ist, gibt die `toJSON` Methode ein einfaches JavaScript-Objekt (als `Excel.Interfaces.TableRowData`) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

Details zur Eigenschaft

context

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

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

index

Gibt die Indexnummer der Zeile in der Zeilenauflistung der Tabelle zurück. Nullindiziert.

readonly index: number;

Eigenschaftswert

number

Hinweise

API-Satz: ExcelApi 1.1

values

Stellt die Rohwerte des angegebenen Bereichs dar. Bei den zurückgegebenen Daten kann es sich um Zeichenfolgen, Zahlen oder boolesche Werte handeln. Zellen, die einen Fehler enthalten, geben die Fehlerzeichenfolge zurück. Wenn der zurückgegebene Wert mit einem Pluszeichen ("+"), einem Minuszeichen ("-") oder einem Gleichheitszeichen ("=") beginnt, interpretiert Excel diesen Wert als Formel.

values: any[][];

Eigenschaftswert

any[][]

Hinweise

API-Satz: ExcelApi 1.1

valuesAsJson

Eine JSON-Darstellung der Werte in den Zellen in dieser Tabellenzeile. Im Gegensatz TableRow.valueszu unterstützt unterstützt dies alle Datentypen, TableRow.valuesAsJson die sich in einer Zelle befinden können. Beispiele sind neben den standardmäßigen booleschen, numerischen und Zeichenfolgenwerten auch formatierte Zahlenwerte und Webbilder. Von dieser API zurückgegebene Daten stimmen immer mit dem Gebietsschema en-US überein. Um Daten im Anzeigegebietsschema des Benutzers abzurufen, verwenden Sie TableRow.valuesAsJsonLocal.

valuesAsJson: CellValue[][];

Eigenschaftswert

Excel.CellValue[][]

Hinweise

API-Satz: ExcelApi 1.16

valuesAsJsonLocal

Eine JSON-Darstellung der Werte in den Zellen in dieser Tabellenzeile. Im Gegensatz TableRow.valueszu unterstützt unterstützt dies alle Datentypen, TableRow.valuesAsJsonLocal die sich in einer Zelle befinden können. Beispiele sind neben den standardmäßigen booleschen, numerischen und Zeichenfolgenwerten auch formatierte Zahlenwerte und Webbilder. Die von dieser API zurückgegebenen Daten entsprechen immer dem Anzeigegebietsschema des Benutzers. Um Daten unabhängig vom Gebietsschema abzurufen, verwenden Sie TableRow.valuesAsJson.

valuesAsJsonLocal: CellValue[][];

Eigenschaftswert

Excel.CellValue[][]

Hinweise

API-Satz: ExcelApi 1.16

Details zur Methode

delete()

Löscht die Zeile aus der Tabelle.

delete(): void;

Gibt zurück

void

Hinweise

API-Satz: ExcelApi 1.1

Beispiele

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

getRange()

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

getRange(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

API-Satz: ExcelApi 1.1

Beispiele

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const row = context.workbook.tables.getItem(tableName).rows.getItemAt(0);
    const rowRange = row.getRange();
    rowRange.load('address');
    await context.sync();
    
    console.log(rowRange.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.TableRowLoadOptions): Excel.TableRow;

Parameter

options: Excel.Interfaces.TableRowLoadOptions

Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.

Gibt zurück

Excel.TableRow

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

Parameter

propertyNames: string | string[]

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

Gibt zurück

Excel.TableRow

Beispiele

await Excel.run(async (context) => { 
    const tableName = 'Table1';
    const row = context.workbook.tables.getItem(tableName).rows.getItemAt(0);
    row.load('index');
    await context.sync();
    
    console.log(row.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?: {
            select?: string;
            expand?: string;
        }): Excel.TableRow;

Parameter

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Excel.TableRow

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.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties: Excel.Interfaces.TableRowUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options: OfficeExtension.UpdateOptions

Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt 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.TableRow): void;

Parameter

properties: Excel.TableRow

Gibt zurück

void

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

toJSON(): Excel.Interfaces.TableRowData;

Gibt zurück

Excel.Interfaces.TableRowData

Feedback

War diese Seite hilfreich?