Word.TableRow class

Paket:

word

Stellt eine Zeile in einem Word Dokument dar.

Extends

OfficeExtension.ClientObject

Hinweise

[ API-Satz: WordApi 1.3 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets content alignment details about the first cell of the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const firstTableRow: Word.TableRow = firstTable.rows.getFirst();
  const firstCell: Word.TableCell = firstTableRow.cells.getFirst();
  firstCell.load(["horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table's first cell:`, `- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`, `- Vertical alignment of the cell's content: ${firstCell.verticalAlignment}`);
});

Eigenschaften

cellCount	Ruft die Anzahl der Zellen in der Zeile ab.
cells	Ruft Zellen ab.
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
font	Ruft die Schriftart ab. Verwenden Sie diese Option zum Abrufen und Festlegen des Schriftartnamens, der Größe, der Farbe und anderer Eigenschaften.
horizontalAlignment	Gibt die horizontale Ausrichtung jeder Zelle in der Zeile an. Der Wert kann "Left", "Centered", "Right" oder "Justified" lauten.
isHeader	Überprüft, ob die Zeile eine Kopfzeile ist. Um die Anzahl der Kopfzeilen festzulegen, verwenden Sie headerRowCount für das Table-Objekt.
parentTable	Ruft die übergeordnete Tabelle ab.
preferredHeight	Gibt die bevorzugte Höhe der Zeile in Punkt an.
rowIndex	Ruft den Index der Zeile in der übergeordneten Tabelle ab.
shadingColor	Gibt die Schattierungsfarbe an. Die Farbe wird im Format "#RRGGBB" oder mit dem Namen der Farbe angegeben.
values	Gibt die Textwerte in der Zeile als 2D-JavaScript-Array an.
verticalAlignment	Gibt die vertikale Ausrichtung der Zellen in der Zeile an. Der Wert kann "Top", "Center" oder "Bottom" sein.

Methoden

clear()	Löscht den Inhalt der Zeile.
delete()	Löscht die gesamte Zeile.
getBorder(borderLocation)	Ruft die Rahmenart der Zellen in der Zeile ab.
getBorder(borderLocationString)	Ruft die Rahmenart der Zellen in der Zeile ab.
getCellPadding(cellPaddingLocation)	Ruft den Textabstand in Punkt ab.
getCellPadding(cellPaddingLocationString)	Ruft den Textabstand in Punkt ab.
getNext()	Ruft die nächste Zeile ab. Löst einen Fehler aus ItemNotFound , wenn diese Zeile die letzte ist.
getNextOrNullObject()	Ruft die nächste Zeile ab. Wenn diese Zeile die letzte ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
insertRows(insertLocation, rowCount, values)	Fügt Zeilen mit dieser Zeile als Vorlage ein. Wenn Werte angegeben sind, werden die Werte in die neuen Zeilen eingefügt.
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.
search(searchText, searchOptions)	Führt eine Suche mit den angegebenen SearchOptions für den Bereich der Zeile aus. Die Suchergebnisse sind eine Sammlung von Bereichsobjekten.
select(selectionMode)	Wählt die Zeile aus und navigiert in der Word-Benutzeroberfläche zur dieser Position.
select(selectionModeString)	Wählt die Zeile aus und navigiert in der Word-Benutzeroberfläche zur dieser Position.
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.
setCellPadding(cellPaddingLocation, cellPadding)	Legt den Textabstand in Punkt fest.
setCellPadding(cellPaddingLocationString, cellPadding)	Legt den Textabstand in Punkt fest.
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 Word.TableRow Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.TableRowData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
track()	Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.
untrack()	Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.

Details zur Eigenschaft

cellCount

Ruft die Anzahl der Zellen in der Zeile ab.

readonly cellCount: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApi 1.3 ]

cells

Ruft Zellen ab.

readonly cells: Word.TableCellCollection;

Eigenschaftswert

Word.TableCellCollection

Hinweise

[ API-Satz: WordApi 1.3 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets content alignment details about the first cell of the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const firstTableRow: Word.TableRow = firstTable.rows.getFirst();
  const firstCell: Word.TableCell = firstTableRow.cells.getFirst();
  firstCell.load(["horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table's first cell:`, `- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`, `- Vertical alignment of the cell's content: ${firstCell.verticalAlignment}`);
});

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

Word.RequestContext

font

Ruft die Schriftart ab. Verwenden Sie diese Option zum Abrufen und Festlegen des Schriftartnamens, der Größe, der Farbe und anderer Eigenschaften.

readonly font: Word.Font;

Eigenschaftswert

Word.Font

Hinweise

[ API-Satz: WordApi 1.3 ]

horizontalAlignment

Gibt die horizontale Ausrichtung jeder Zelle in der Zeile an. Der Wert kann "Left", "Centered", "Right" oder "Justified" lauten.

horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";

Eigenschaftswert

Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"

Hinweise

[ API-Satz: WordApi 1.3 ]

isHeader

Überprüft, ob die Zeile eine Kopfzeile ist. Um die Anzahl der Kopfzeilen festzulegen, verwenden Sie headerRowCount für das Table-Objekt.

readonly isHeader: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.3 ]

parentTable

Ruft die übergeordnete Tabelle ab.

readonly parentTable: Word.Table;

Eigenschaftswert

Word.Table

Hinweise

[ API-Satz: WordApi 1.3 ]

preferredHeight

Gibt die bevorzugte Höhe der Zeile in Punkt an.

preferredHeight: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApi 1.3 ]

rowIndex

Ruft den Index der Zeile in der übergeordneten Tabelle ab.

readonly rowIndex: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApi 1.3 ]

shadingColor

Gibt die Schattierungsfarbe an. Die Farbe wird im Format "#RRGGBB" oder mit dem Namen der Farbe angegeben.

shadingColor: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.3 ]

values

Gibt die Textwerte in der Zeile als 2D-JavaScript-Array an.

values: string[][];

Eigenschaftswert

string[][]

Hinweise

[ API-Satz: WordApi 1.3 ]

verticalAlignment

Gibt die vertikale Ausrichtung der Zellen in der Zeile an. Der Wert kann "Top", "Center" oder "Bottom" sein.

verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom";

Eigenschaftswert

Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"

Hinweise

[ API-Satz: WordApi 1.3 ]

Details zur Methode

clear()

Löscht den Inhalt der Zeile.

clear(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

delete()

Löscht die gesamte Zeile.

delete(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

getBorder(borderLocation)

Ruft die Rahmenart der Zellen in der Zeile ab.

getBorder(borderLocation: Word.BorderLocation): Word.TableBorder;

Parameter

borderLocation

Word.BorderLocation

Erforderlich. Die Position des Rahmens.

Gibt zurück

Word.TableBorder

Hinweise

[ API-Satz: WordApi 1.3 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets border details about the first row of the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const firstTableRow: Word.TableRow = firstTable.rows.getFirst();
  const borderLocation = Word.BorderLocation.bottom;
  const border: Word.TableBorder = firstTableRow.getBorder(borderLocation);
  border.load(["type", "color", "width"]);
  await context.sync();

  console.log(`Details about the ${borderLocation} border of the first table's first row:`, `- Color: ${border.color}`, `- Type: ${border.type}`, `- Width: ${border.width} points`);
});

getBorder(borderLocationString)

Ruft die Rahmenart der Zellen in der Zeile ab.

getBorder(borderLocationString: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder;

Parameter

borderLocationString

"Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"

Erforderlich. Die Position des Rahmens.

Gibt zurück

Word.TableBorder

Hinweise

[ API-Satz: WordApi 1.3 ]

getCellPadding(cellPaddingLocation)

Ruft den Textabstand in Punkt ab.

getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult<number>;

Parameter

cellPaddingLocation

Word.CellPaddingLocation

Erforderlich. Die Zellenauffüllung muss "Oben", "Links", "Unten" oder "Rechts" sein.

Gibt zurück

OfficeExtension.ClientResult<number>

Hinweise

[ API-Satz: WordApi 1.3 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-formatting.yaml

// Gets cell padding details about the first row of the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const firstTableRow: Word.TableRow = firstTable.rows.getFirst();
  const cellPaddingLocation = Word.CellPaddingLocation.bottom;
  const cellPadding = firstTableRow.getCellPadding(cellPaddingLocation);
  await context.sync();

  console.log(
    `Cell padding details about the ${cellPaddingLocation} border of the first table's first row: ${cellPadding.value} points`
  );
});

getCellPadding(cellPaddingLocationString)

Ruft den Textabstand in Punkt ab.

getCellPadding(cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult<number>;

Parameter

cellPaddingLocationString

"Top" | "Left" | "Bottom" | "Right"

Erforderlich. Die Zellenauffüllung muss "Oben", "Links", "Unten" oder "Rechts" sein.

Gibt zurück

OfficeExtension.ClientResult<number>

Hinweise

[ API-Satz: WordApi 1.3 ]

getNext()

Ruft die nächste Zeile ab. Löst einen Fehler aus ItemNotFound , wenn diese Zeile die letzte ist.

getNext(): Word.TableRow;

Gibt zurück

Word.TableRow

Hinweise

[ API-Satz: WordApi 1.3 ]

getNextOrNullObject()

Ruft die nächste Zeile ab. Wenn diese Zeile die letzte ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getNextOrNullObject(): Word.TableRow;

Gibt zurück

Word.TableRow

Hinweise

[ API-Satz: WordApi 1.3 ]

insertRows(insertLocation, rowCount, values)

Fügt Zeilen mit dieser Zeile als Vorlage ein. Wenn Werte angegeben sind, werden die Werte in die neuen Zeilen eingefügt.

insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection;

Parameter

insertLocation

before | after | "Before" | "After"

Erforderlich. Der Ort, an dem die neuen Zeilen eingefügt werden sollen, relativ zur aktuellen Zeile. Es muss "Vor" oder "Nach" sein.

rowCount

number

Erforderlich. Anzahl der hinzuzufügenden Zeilen

values

string[][]

Optional. Zeichenfolgen, die in die neuen Zeilen eingefügt werden sollen, die als 2D-Array angegeben sind. Die Anzahl der Zellen in jeder Zeile darf die Anzahl der Zellen in der vorhandenen Zeile nicht überschreiten.

Gibt zurück

Word.TableRowCollection

Hinweise

[ API-Satz: WordApi 1.3 ]

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?: Word.Interfaces.TableRowLoadOptions): Word.TableRow;

Parameter

options

Word.Interfaces.TableRowLoadOptions

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

Gibt zurück

Word.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[]): Word.TableRow;

Parameter

propertyNames

string | string[]

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

Gibt zurück

Word.TableRow

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;
        }): Word.TableRow;

Parameter

propertyNamesAndPaths

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

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

Word.TableRow

search(searchText, searchOptions)

Führt eine Suche mit den angegebenen SearchOptions für den Bereich der Zeile aus. Die Suchergebnisse sind eine Sammlung von Bereichsobjekten.

search(searchText: string, searchOptions?: Word.SearchOptions | {
            ignorePunct?: boolean;
            ignoreSpace?: boolean;
            matchCase?: boolean;
            matchPrefix?: boolean;
            matchSuffix?: boolean;
            matchWholeWord?: boolean;
            matchWildcards?: boolean;
        }): Word.RangeCollection;

Parameter

searchText

string

Erforderlich. Der Suchtext.

searchOptions

Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }

Optional. Optionen für die Suche.

Gibt zurück

Word.RangeCollection

Hinweise

[ API-Satz: WordApi 1.3 ]

select(selectionMode)

Wählt die Zeile aus und navigiert in der Word-Benutzeroberfläche zur dieser Position.

select(selectionMode?: Word.SelectionMode): void;

Parameter

selectionMode

Word.SelectionMode

Optional. Der Auswahlmodus muss "Select", "Start" oder "End" sein. „Select“ ist die Standardeinstellung.

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

select(selectionModeString)

Wählt die Zeile aus und navigiert in der Word-Benutzeroberfläche zur dieser Position.

select(selectionModeString?: "Select" | "Start" | "End"): void;

Parameter

selectionModeString

"Select" | "Start" | "End"

Optional. Der Auswahlmodus muss "Select", "Start" oder "End" sein. „Select“ ist die Standardeinstellung.

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

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

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

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt 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: Word.TableRow): void;

Parameter

properties

Word.TableRow

Gibt zurück

void

setCellPadding(cellPaddingLocation, cellPadding)

Legt den Textabstand in Punkt fest.

setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void;

Parameter

cellPaddingLocation

Word.CellPaddingLocation

Erforderlich. Die Zellenauffüllung muss "Oben", "Links", "Unten" oder "Rechts" sein.

cellPadding

number

Erforderlich. Der Zellabstand.

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

setCellPadding(cellPaddingLocationString, cellPadding)

Legt den Textabstand in Punkt fest.

setCellPadding(cellPaddingLocationString: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void;

Parameter

cellPaddingLocationString

"Top" | "Left" | "Bottom" | "Right"

Erforderlich. Die Zellenauffüllung muss "Oben", "Links", "Unten" oder "Rechts" sein.

cellPadding

number

Erforderlich. Der Zellabstand.

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

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 Word.TableRow Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.TableRowData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Word.Interfaces.TableRowData;

Gibt zurück

Word.Interfaces.TableRowData

track()

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.

track(): Word.TableRow;

Gibt zurück

Word.TableRow

untrack()

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Word.TableRow;

Gibt zurück

Word.TableRow