Word.Table class

Referenz

Paket:: word

Stellt eine Tabelle in einem Word Dokument dar.

Extends: OfficeExtension.ClientObject

Hinweise

Beispiele

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

await Word.run(async (context) => {
  // Use a two-dimensional array to hold the initial table values.
  const data = [
    ["Tokyo", "Beijing", "Seattle"],
    ["Apple", "Orange", "Pineapple"]
  ];
  const table = context.document.body.insertTable(2, 3, "Start", data);
  table.styleBuiltIn = Word.BuiltInStyleName.gridTable5Dark_Accent2;
  table.styleFirstColumn = false;

  await context.sync();
});

Eigenschaften

alignment	Gibt die Ausrichtung der Tabelle an der Seitenspalte an. Der Wert kann "Left", "Centered" oder "Right" sein.
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
endnotes	Ruft die Auflistung der Endnoten in der Tabelle ab.
fields	Ruft die Auflistung von Feldobjekten in der Tabelle ab.
font	Ruft die Schriftart ab. Verwenden Sie diese Option zum Abrufen und Festlegen des Schriftartnamens, der Größe, der Farbe und anderer Eigenschaften.
footnotes	Ruft die Auflistung der Fußnoten in der Tabelle ab.
headerRowCount	Gibt die Anzahl der Headerzeilen an.
horizontalAlignment	Gibt die horizontale Ausrichtung jeder Zelle in der Tabelle an. Der Wert kann "Left", "Centered", "Right" oder "Justified" lauten.
isUniform	Gibt an, ob alle Zeilen der Tabelle uniform sind.
nestingLevel	Ruft die Schachtelungsebene der Tabelle ab. Tabellen der obersten Ebene haben Ebene 1.
parentBody	Ruft den übergeordneten Text der Tabelle ab.
parentContentControl	Ruft das Inhaltssteuerelement ab, das die Tabelle enthält. Löst einen Fehler aus `ItemNotFound` , wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist.
parentContentControlOrNullObject	Ruft das Inhaltssteuerelement ab, das die Tabelle enthält. Wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist, gibt diese Methode ein Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
parentTable	Ruft die Tabelle ab, die diese Tabelle enthält. Löst einen Fehler aus `ItemNotFound` , wenn er nicht in einer Tabelle enthalten ist.
parentTableCell	Ruft die Tabellenzelle ab, die diese Tabelle enthält. Löst einen Fehler aus `ItemNotFound` , wenn er nicht in einer Tabellenzelle enthalten ist.
parentTableCellOrNullObject	Ruft die Tabellenzelle ab, die diese Tabelle enthält. Wenn sie nicht in einer Tabellenzelle enthalten ist, gibt diese Methode ein Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
parentTableOrNullObject	Ruft die Tabelle ab, die diese Tabelle enthält. Wenn sie nicht in einer Tabelle enthalten ist, gibt diese Methode ein -Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
rowCount	Ruft die Anzahl der Zeilen in der Tabelle ab.
rows	Ruft alle Zeilen der Tabelle ab.
shadingColor	Gibt die Schattierungsfarbe an. Die Farbe wird im Format "#RRGGBB" oder mit dem Namen der Farbe angegeben.
style	Gibt den Formatvorlagennamen für die Tabelle an. Verwenden Sie diese Eigenschaft für benutzerdefinierte Formatvorlagen und lokalisierte Formatvorlagennamen. Informationen zur Verwendung der integrierten Formatvorlagen, die zwischen Gebietsschemas portabel sind, finden Sie unter der Eigenschaft "styleBuiltIn".
styleBandedColumns	Gibt an, ob die Tabelle über gebänderte Spalten verfügt.
styleBandedRows	Gibt an, ob die Tabelle über gebänderte Zeilen verfügt.
styleBuiltIn	Gibt den integrierten Formatvorlagennamen für die Tabelle an. Verwenden Sie diese Eigenschaft für integrierte Formatvorlagen, die zwischen Gebietsschemas portabel sind. Informationen zum Verwenden benutzerdefinierter Formatvorlagen oder lokalisierter Namen finden Sie unter der Eigenschaft "style".
styleFirstColumn	Gibt an, ob die Tabelle über eine erste Spalte mit einer speziellen Formatvorlage verfügt.
styleLastColumn	Gibt an, ob die Tabelle eine letzte Spalte mit einem speziellen Format aufweist.
styleTotalRow	Gibt an, ob die Tabelle über eine (letzte) Gesamtzeile mit einer speziellen Formatvorlage verfügt.
tables	Ruft die untergeordneten Tabellen ab, die eine Ebene tiefer verschachtelt sind.
values	Gibt die Textwerte in der Tabelle als 2D-JavaScript-Array an.
verticalAlignment	Gibt die vertikale Ausrichtung jeder Zelle in der Tabelle an. Der Wert kann "Top", "Center" oder "Bottom" sein.
width	Gibt die Breite der Tabelle in Punkt an.

Methoden

addColumns(insertLocation, columnCount, values)	Fügt am Anfang oder Ende der Tabelle Spalten hinzu, wobei die erste oder letzte vorhandene Spalte als Vorlage verwendet wird. Dies gilt für einheitliche Tabellen. Falls Zeichenfolgenwerte angegeben werden, werden diese in den neu eingefügten Zeilen festgelegt.
addRows(insertLocation, rowCount, values)	Fügt am Anfang oder Ende der Tabelle Zeilen hinzu, wobei die erste oder letzte vorhandene Zeile als Vorlage verwendet wird. Falls Zeichenfolgenwerte angegeben werden, werden diese in den neu eingefügten Zeilen festgelegt.
autoFitWindow()	Passt die Tabellenspalten automatisch an die Breite des Fensters an.
clear()	Löscht den Inhalt der Tabelle.
delete()	Löscht die gesamte Tabelle.
deleteColumns(columnIndex, columnCount)	Löscht bestimmte Spalten. Dies gilt für einheitliche Tabellen.
deleteRows(rowIndex, rowCount)	Löscht bestimmte Zeilen.
distributeColumns()	Verteilt die Breite der Spalten gleichmäßig. Dies gilt für einheitliche Tabellen.
getBorder(borderLocation)	Ruft die Rahmenart für den angegebenen Rahmen ab.
getBorder(borderLocationString)	Ruft die Rahmenart für den angegebenen Rahmen ab.
getCell(rowIndex, cellIndex)	Ruft die Tabellenzelle in einer angegebenen Zeile und Spalte ab. Löst einen Fehler aus `ItemNotFound` , wenn die angegebene Tabellenzelle nicht vorhanden ist.
getCellOrNullObject(rowIndex, cellIndex)	Ruft die Tabellenzelle in einer angegebenen Zeile und Spalte ab. Wenn die angegebene Tabellenzelle nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getCellPadding(cellPaddingLocation)	Ruft den Textabstand in Punkt ab.
getCellPadding(cellPaddingLocationString)	Ruft den Textabstand in Punkt ab.
getNext()	Ruft die nächste Tabelle ab. Löst einen Fehler aus `ItemNotFound` , wenn diese Tabelle die letzte ist.
getNextOrNullObject()	Ruft die nächste Tabelle ab. Wenn es sich bei dieser Tabelle um die letzte Tabelle handelt, gibt diese Methode ein -Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getParagraphAfter()	Ruft den Absatz nach der Tabelle ab. Löst einen Fehler aus `ItemNotFound` , wenn nach der Tabelle kein Absatz vorhanden ist.
getParagraphAfterOrNullObject()	Ruft den Absatz nach der Tabelle ab. Wenn nach der Tabelle kein Absatz vorhanden ist, gibt diese Methode ein Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getParagraphBefore()	Ruft den Absatz vor der Tabelle ab. Löst einen Fehler aus `ItemNotFound` , wenn vor der Tabelle kein Absatz vorhanden ist.
getParagraphBeforeOrNullObject()	Ruft den Absatz vor der Tabelle ab. Wenn vor der Tabelle kein Absatz vorhanden ist, gibt diese Methode ein Objekt zurück, dessen `isNullObject` -Eigenschaft auf `true`festgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getRange(rangeLocation)	Ruft den Bereich ab, der diese Tabelle enthält, oder den Bereich am Anfang bzw. Ende der Tabelle.
insertContentControl()	Fügt ein Inhaltssteuerelement in der Tabelle ein.
insertParagraph(paragraphText, insertLocation)	Fügt an der angegebenen Position einen Absatz ein.
insertTable(rowCount, columnCount, insertLocation, values)	Fügt eine Tabelle mit der angegebenen Anzahl von Zeilen und Spalten 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 "`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.
mergeCells(topRow, firstCell, bottomRow, lastCell)	Führt die Zellen zusammen, die inklusive durch eine erste und letzte Zelle begrenzt sind.
search(searchText, searchOptions)	Führt eine Suche mit den angegebenen SearchOptions für den Bereich des Tabellenobjekts aus. Die Suchergebnisse sind eine Sammlung von Bereichsobjekten.
select(selectionMode)	Wählt die Tabelle oder die Position am Anfang oder Ende der Tabelle aus und navigiert die Word-Benutzeroberfläche an diese Position.
select(selectionModeString)	Wählt die Tabelle oder die Position am Anfang oder Ende der Tabelle aus und navigiert die Word-Benutzeroberfläche an diese 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.stringify`ruft wiederum die `toJSON` -Methode des Objekts auf, das an das Objekt übergeben wird.) Die ursprüngliche Word. Das Table-Objekt ist ein API-Objekt. Die `toJSON` Methode gibt ein einfaches JavaScript-Objekt (typisiert als `Word.Interfaces.TableData`) 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

alignment

Gibt die Ausrichtung der Tabelle an der Seitenspalte an. Der Wert kann "Left", "Centered" oder "Right" sein.

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

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 alignment details about the first table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table:`);
  console.log(`- Alignment of the table within the containing page column: ${firstTable.alignment}`);
  console.log(`- Horizontal alignment of every cell in the table: ${firstTable.horizontalAlignment}`);
  console.log(`- Vertical alignment of every cell in the table: ${firstTable.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

endnotes

Ruft die Auflistung der Endnoten in der Tabelle ab.

readonly endnotes: Word.NoteItemCollection;

Eigenschaftswert

Word.NoteItemCollection

Hinweise

[ API-Satz: WordApi 1.5 ]

fields

Ruft die Auflistung von Feldobjekten in der Tabelle ab.

readonly fields: Word.FieldCollection;

Eigenschaftswert

Word.FieldCollection

Hinweise

[ API-Satz: WordApi 1.4 ]

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 ]

footnotes

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

readonly footnotes: Word.NoteItemCollection;

Eigenschaftswert

Word.NoteItemCollection

Hinweise

[ API-Satz: WordApi 1.5 ]

headerRowCount

Gibt die Anzahl der Headerzeilen an.

headerRowCount: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApi 1.3 ]

horizontalAlignment

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

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

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 alignment details about the first table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table:`);
  console.log(`- Alignment of the table within the containing page column: ${firstTable.alignment}`);
  console.log(`- Horizontal alignment of every cell in the table: ${firstTable.horizontalAlignment}`);
  console.log(`- Vertical alignment of every cell in the table: ${firstTable.verticalAlignment}`);
});

isUniform

Gibt an, ob alle Zeilen der Tabelle uniform sind.

readonly isUniform: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.3 ]

nestingLevel

Ruft die Schachtelungsebene der Tabelle ab. Tabellen der obersten Ebene haben Ebene 1.

readonly nestingLevel: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApi 1.3 ]

parentBody

Ruft den übergeordneten Text der Tabelle ab.

readonly parentBody: Word.Body;

Eigenschaftswert

Word.Body

Hinweise

[ API-Satz: WordApi 1.3 ]

parentContentControl

Ruft das Inhaltssteuerelement ab, das die Tabelle enthält. Löst einen Fehler aus ItemNotFound , wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist.

readonly parentContentControl: Word.ContentControl;

Eigenschaftswert

Word.ContentControl

Hinweise

[ API-Satz: WordApi 1.3 ]

parentContentControlOrNullObject

Ruft das Inhaltssteuerelement ab, das die Tabelle enthält. Wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

readonly parentContentControlOrNullObject: Word.ContentControl;

Eigenschaftswert

Word.ContentControl

Hinweise

[ API-Satz: WordApi 1.3 ]

parentTable

Ruft die Tabelle ab, die diese Tabelle enthält. Löst einen Fehler aus ItemNotFound , wenn er nicht in einer Tabelle enthalten ist.

readonly parentTable: Word.Table;

Eigenschaftswert

Word.Table

Hinweise

[ API-Satz: WordApi 1.3 ]

parentTableCell

Ruft die Tabellenzelle ab, die diese Tabelle enthält. Löst einen Fehler aus ItemNotFound , wenn er nicht in einer Tabellenzelle enthalten ist.

readonly parentTableCell: Word.TableCell;

Eigenschaftswert

Word.TableCell

Hinweise

[ API-Satz: WordApi 1.3 ]

parentTableCellOrNullObject

Ruft die Tabellenzelle ab, die diese Tabelle enthält. Wenn sie nicht in einer Tabellenzelle enthalten ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

readonly parentTableCellOrNullObject: Word.TableCell;

Eigenschaftswert

Word.TableCell

Hinweise

[ API-Satz: WordApi 1.3 ]

parentTableOrNullObject

Ruft die Tabelle ab, die diese Tabelle enthält. Wenn sie nicht in einer Tabelle enthalten ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

readonly parentTableOrNullObject: Word.Table;

Eigenschaftswert

Word.Table

Hinweise

[ API-Satz: WordApi 1.3 ]

rowCount

Ruft die Anzahl der Zeilen in der Tabelle ab.

readonly rowCount: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApi 1.3 ]

rows

Ruft alle Zeilen der Tabelle ab.

readonly rows: Word.TableRowCollection;

Eigenschaftswert

Word.TableRowCollection

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 row of the first table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  const firstTableRow = firstTable.rows.getFirst();
  firstTableRow.load(["horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table's first row:`);
  console.log(`- Horizontal alignment of every cell in the row: ${firstTableRow.horizontalAlignment}`);
  console.log(`- Vertical alignment of every cell in the row: ${firstTableRow.verticalAlignment}`);
});

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 ]

style

Gibt den Formatvorlagennamen für die Tabelle an. Verwenden Sie diese Eigenschaft für benutzerdefinierte Formatvorlagen und lokalisierte Formatvorlagennamen. Informationen zur Verwendung der integrierten Formatvorlagen, die zwischen Gebietsschemas portabel sind, finden Sie unter der Eigenschaft "styleBuiltIn".

style: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.3 ]

styleBandedColumns

Gibt an, ob die Tabelle über gebänderte Spalten verfügt.

styleBandedColumns: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.3 ]

styleBandedRows

Gibt an, ob die Tabelle über gebänderte Zeilen verfügt.

styleBandedRows: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.3 ]

styleBuiltIn

Gibt den integrierten Formatvorlagennamen für die Tabelle an. Verwenden Sie diese Eigenschaft für integrierte Formatvorlagen, die zwischen Gebietsschemas portabel sind. Informationen zum Verwenden benutzerdefinierter Formatvorlagen oder lokalisierter Namen finden Sie unter der Eigenschaft "style".

styleBuiltIn: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.3 ]

styleFirstColumn

Gibt an, ob die Tabelle über eine erste Spalte mit einer speziellen Formatvorlage verfügt.

styleFirstColumn: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.3 ]

styleLastColumn

Gibt an, ob die Tabelle eine letzte Spalte mit einem speziellen Format aufweist.

styleLastColumn: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.3 ]

styleTotalRow

Gibt an, ob die Tabelle über eine (letzte) Gesamtzeile mit einer speziellen Formatvorlage verfügt.

styleTotalRow: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.3 ]

tables

Ruft die untergeordneten Tabellen ab, die eine Ebene tiefer verschachtelt sind.

readonly tables: Word.TableCollection;

Eigenschaftswert

Word.TableCollection

Hinweise

[ API-Satz: WordApi 1.3 ]

values

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

values: string[][];

Eigenschaftswert

string[][]

Hinweise

[ API-Satz: WordApi 1.3 ]

verticalAlignment

Gibt die vertikale Ausrichtung jeder Zelle in der Tabelle 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 ]

Beispiele

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

// Gets alignment details about the first table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  firstTable.load(["alignment", "horizontalAlignment", "verticalAlignment"]);
  await context.sync();

  console.log(`Details about the alignment of the first table:`);
  console.log(`- Alignment of the table within the containing page column: ${firstTable.alignment}`);
  console.log(`- Horizontal alignment of every cell in the table: ${firstTable.horizontalAlignment}`);
  console.log(`- Vertical alignment of every cell in the table: ${firstTable.verticalAlignment}`);
});

width

Gibt die Breite der Tabelle in Punkt an.

width: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApi 1.3 ]

Details zur Methode

addColumns(insertLocation, columnCount, values)

Fügt am Anfang oder Ende der Tabelle Spalten hinzu, wobei die erste oder letzte vorhandene Spalte als Vorlage verwendet wird. Dies gilt für einheitliche Tabellen. Falls Zeichenfolgenwerte angegeben werden, werden diese in den neu eingefügten Zeilen festgelegt.

addColumns(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", columnCount: number, values?: string[][]): void;

Parameter

insertLocation: start | end | "Start" | "End"

Erforderlich. Es muss "Start" oder "Ende" lauten, was der entsprechenden Seite der Tabelle entspricht.

columnCount: number

Erforderlich. Anzahl der hinzuzufügenden Spalten.

values: string[][]

Optionales 2D-Array. Wenn die entsprechenden Zeichenfolgen im Array angegeben sind, werden die Zellen gefüllt.

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

addRows(insertLocation, rowCount, values)

Fügt am Anfang oder Ende der Tabelle Zeilen hinzu, wobei die erste oder letzte vorhandene Zeile als Vorlage verwendet wird. Falls Zeichenfolgenwerte angegeben werden, werden diese in den neu eingefügten Zeilen festgelegt.

addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection;

Parameter

insertLocation: start | end | "Start" | "End"

Erforderlich. Es muss "Start" oder "End" sein.

rowCount: number

Erforderlich. Anzahl der hinzuzufügenden Zeilen.

values: string[][]

deleteColumns(columnIndex: number, columnCount?: number): void;

Parameter

columnIndex: number

Erforderlich. Die erste zu löschende Spalte.

columnCount: number

Optional. Die Anzahl der zu löschenden Spalten. Standardwert 1.

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

deleteRows(rowIndex, rowCount)

Löscht bestimmte Zeilen.

deleteRows(rowIndex: number, rowCount?: number): void;

Parameter

rowIndex: number

Erforderlich. Die erste zu löschende Zeile.

rowCount: number

Optional. Die Anzahl der zu löschenden Zeilen. Standardwert 1.

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

distributeColumns()

Verteilt die Breite der Spalten gleichmäßig. Dies gilt für einheitliche Tabellen.

distributeColumns(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

getBorder(borderLocation)

Ruft die Rahmenart für den angegebenen Rahmen 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 table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  const borderLocation = Word.BorderLocation.top;
  const border = firstTable.getBorder(borderLocation);
  border.load(["type", "color", "width"]);
  await context.sync();

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

getBorder(borderLocationString)

Ruft die Rahmenart für den angegebenen Rahmen 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 ]

getCell(rowIndex, cellIndex)

Ruft die Tabellenzelle in einer angegebenen Zeile und Spalte ab. Löst einen Fehler aus ItemNotFound , wenn die angegebene Tabellenzelle nicht vorhanden ist.

getCell(rowIndex: number, cellIndex: number): Word.TableCell;

Parameter

rowIndex: number

Erforderlich. Der Index der Zeile.

cellIndex: number

Erforderlich. Der Index der Zelle in der Zeile.

Gibt zurück

Word.TableCell

Hinweise

[ API-Satz: WordApi 1.3 ]

Beispiele

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

// Gets the content of the first cell in the first table.
await Word.run(async (context) => {
  const firstCell = context.document.body.tables.getFirst().getCell(0, 0).body;
  firstCell.load("text");

  await context.sync();
  console.log("First cell's text is: " + firstCell.text);
});

getCellOrNullObject(rowIndex, cellIndex)

Ruft die Tabellenzelle in einer angegebenen Zeile und Spalte ab. Wenn die angegebene Tabellenzelle nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getCellOrNullObject(rowIndex: number, cellIndex: number): Word.TableCell;

Parameter

rowIndex: number

Erforderlich. Der Index der Zeile.

cellIndex: number

Erforderlich. Der Index der Zelle in der Zeile.

Gibt zurück

Word.TableCell

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 table in the document.
await Word.run(async (context) => {
  const firstTable = context.document.body.tables.getFirst();
  const cellPaddingLocation = Word.CellPaddingLocation.right;
  const cellPadding = firstTable.getCellPadding(cellPaddingLocation);
  await context.sync();

  console.log(
    `Cell padding details about the ${cellPaddingLocation} border of the first table: ${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"

getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | Word.RangeLocation.after | "Whole" | "Start" | "End" | "After"): Word.Range;

Parameter

rangeLocation: whole | start | end | after | "Whole" | "Start" | "End" | "After"

Optional. Der Bereichsspeicherort muss "Whole", "Start", "End" oder "After" sein.

Gibt zurück

Word.Range

Hinweise

[ API-Satz: WordApi 1.3 ]

insertContentControl()

Fügt ein Inhaltssteuerelement in der Tabelle ein.

insertContentControl(): Word.ContentControl;

Gibt zurück

Word.ContentControl

Hinweise

[ API-Satz: WordApi 1.3 ]

insertParagraph(paragraphText, insertLocation)

Fügt an der angegebenen Position einen Absatz ein.

insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After"): Word.Paragraph;

Parameter

paragraphText: string

Erforderlich. Der einzufügende Absatztext.

insertLocation: before | after | "Before" | "After"

Erforderlich. Der Wert muss "Before" oder "After" sein.

Gibt zurück

Word.Paragraph

Hinweise

[ API-Satz: WordApi 1.3 ]

insertTable(rowCount, columnCount, insertLocation, values)

Fügt eine Tabelle mit der angegebenen Anzahl von Zeilen und Spalten ein.

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

Parameter

rowCount: number

Erforderlich. Die Anzahl der Zeilen in der Tabelle.

columnCount: number

Erforderlich. Die Anzahl der Spalten in der Tabelle.

insertLocation: before | after | "Before" | "After"

Erforderlich. Der Wert muss "Before" oder "After" sein.

values: string[][]

Optionales 2D-Array. Wenn die entsprechenden Zeichenfolgen im Array angegeben sind, werden die Zellen gefüllt.

Gibt zurück

Word.Table

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.TableLoadOptions): Word.Table;

Parameter

options: Word.Interfaces.TableLoadOptions

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

Gibt zurück

Word.Table

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

Parameter

propertyNames: string | string[]

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

Gibt zurück

Word.Table

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

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

mergeCells(topRow, firstCell, bottomRow, lastCell)

Führt die Zellen zusammen, die inklusive durch eine erste und letzte Zelle begrenzt sind.

mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number): Word.TableCell;

Parameter

topRow: number

Erforderlich. Die Zeile der ersten Zelle

firstCell: number

Erforderlich. Der Index der ersten Zelle in ihrer Zeile

bottomRow: number

Erforderlich. Die Zeile der letzten Zelle

lastCell: number

Erforderlich. Der Index der letzten Zelle in ihrer Zeile

Gibt zurück

Word.TableCell

Hinweise

[ API-Satz: WordApi 1.4 ]

search(searchText, searchOptions)

Führt eine Suche mit den angegebenen SearchOptions für den Bereich des Tabellenobjekts 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 Tabelle oder die Position am Anfang oder Ende der Tabelle aus und navigiert die Word-Benutzeroberfläche an diese 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 Tabelle oder die Position am Anfang oder Ende der Tabelle aus und navigiert die Word-Benutzeroberfläche an diese 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.TableUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties: Word.Interfaces.TableUpdateData

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.Table): void;

Parameter

properties: Word.Table

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

toJSON(): Word.Interfaces.TableData;

Gibt zurück

Word.Interfaces.TableData

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

Gibt zurück

Word.Table

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

Gibt zurück

Word.Table