Word.TableRow class

Ruft die Anzahl der Zellen in der Zeile ab.

readonly cellCount: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.3 ]

Ruft Zellen ab.

readonly cells: Word.TableCellCollection;

Eigenschaftswert

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}`);
});

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

context: RequestContext;

Eigenschaftswert

Ruft die Auflistung der Endnoten in der Tabellenzeile ab.

readonly endnotes: Word.NoteItemCollection;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.5 ]

Ruft die Auflistung von Field -Objekten in der Tabellenzeile ab.

readonly fields: Word.FieldCollection;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.4 ]

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

Hinweise

[ API-Satz: WordApi 1.3 ]

Ruft die Auflistung der Fußnoten in der Tabellenzeile ab.

readonly footnotes: Word.NoteItemCollection;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.5 ]

Gibt die horizontale Ausrichtung jeder Zelle in der Zeile an. Der Wert kann ,centered ,right oderjustified sein.left

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

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.3 ]

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

readonly isHeader: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.3 ]

Ruft die übergeordnete Tabelle ab.

readonly parentTable: Word.Table;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.3 ]

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

preferredHeight: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.3 ]

Gibt das Range -Objekt zurück, das die Tabellenzeile darstellt.

readonly range: Word.Range;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

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

readonly rowIndex: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.3 ]

Gibt das ShadingUniversal -Objekt zurück, das die Schattierung der Tabellenzeile darstellt.

readonly shading: Word.ShadingUniversal;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

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

shadingColor: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.3 ]

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

values: string[][];

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.3 ]

Gibt die vertikale Ausrichtung der Zellen in der Zeile an. Der Wert kann ,center oderbottom seintop.

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

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.3 ]

Löscht den Inhalt der Zeile.

clear(): void;

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.3 ]

Konvertiert die Tabellenzeile in Text.

convertToText(options?: Word.TableConvertToTextOptions): Word.Range;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Löscht die gesamte Zeile.

delete(): void;

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.3 ]

Ruft die Rahmenart der Zellen in der Zeile ab.

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

Parameter

Gibt zurück

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`);
});

Ruft die Rahmenart der Zellen in der Zeile ab.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.3 ]

Ruft den Textabstand in Punkt ab.

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

Parameter

Gibt zurück

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`
  );
});

Ruft den Textabstand in Punkt ab.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.3 ]

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

getNext(): Word.TableRow;

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.3 ]

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

Hinweise

[ API-Satz: WordApi 1.3 ]

Fügt ein Inhaltssteuerelement in die Zeile ein.

insertContentControl(): Word.ContentControl;

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.1 ]

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

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.3 ]

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

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

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(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.TableRow;

Parameter

Gibt zurück

Führt die Zeile in einer Zelle zusammen.

merge(): Word.TableCell;

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.4 ]

Führt eine Suche mit den angegebenen Suchoptionen für den Bereich der Zeile aus. Die Suchergebnisse sind eine Auflistung von Range -Objekten.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.3 ]

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

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.3 ]

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

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.3 ]

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

Gibt zurück

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Word.TableRow): void;

Parameter

Gibt zurück

Legt den Textabstand in Punkt fest.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.3 ]

Legt den Textabstand in Punkt fest.

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

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApi 1.3 ]

Legt die Höhe der Zeile fest.

setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Legt die Höhe der Zeile fest.

setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Legt den linken Einzug für die Tabellenzeile fest.

setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Legt den linken Einzug für die Tabellenzeile fest.

setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Ü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

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

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