Word.TableCell class

Paket:

word

Stellt eine Tabellenzelle 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

body	Ruft das body-Objekt der Zelle ab.
cellIndex	Ruft den Index der Zelle in der Zeile ab.
columnWidth	Gibt die Breite der Spalte der Zelle in Punkt an. Dies gilt für einheitliche Tabellen.
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
horizontalAlignment	Gibt die horizontale Ausrichtung der Zelle an. Der Wert kann "Left", "Centered", "Right" oder "Justified" lauten.
parentRow	Ruft die übergeordnete Zeile der Zelle ab.
parentTable	Ruft die übergeordnete Tabelle der Zelle ab.
rowIndex	Ruft den Index der Zeile mit der Zelle in der Tabelle ab.
shadingColor	Gibt die Schattierungsfarbe der Zelle an. Die Farbe wird im Format "#RRGGBB" oder mit dem Namen der Farbe angegeben.
value	Gibt den Text der Zelle an.
verticalAlignment	Gibt die vertikale Ausrichtung der Zelle an. Der Wert kann "Top", "Center" oder "Bottom" sein.
width	Ruft die Breite der Zelle in Punkt ab.

Methoden

deleteColumn()	Löscht die Spalte, die diese Zelle enthält. Dies gilt für einheitliche Tabellen.
deleteRow()	Löscht die Zeile, die diese Zelle enthält.
getBorder(borderLocation)	Ruft die Rahmenart für den angegebenen Rahmen ab.
getBorder(borderLocationString)	Ruft die Rahmenart für den angegebenen Rahmen ab.
getCellPadding(cellPaddingLocation)	Ruft den Textabstand in Punkt ab.
getCellPadding(cellPaddingLocationString)	Ruft den Textabstand in Punkt ab.
getNext()	Ruft die nächste Zelle ab. Löst einen Fehler aus ItemNotFound , wenn diese Zelle die letzte ist.
getNextOrNullObject()	Ruft die nächste Zelle ab. Wenn es sich bei dieser Zelle um die letzte Zelle handelt, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
insertColumns(insertLocation, columnCount, values)	Fügt links oder rechts von der Zelle Spalten hinzu, wobei die Spalte der Zelle als Vorlage verwendet wird. Dies gilt für einheitliche Tabellen. Falls Zeichenfolgenwerte angegeben werden, werden diese in den neu eingefügten Zeilen festgelegt.
insertRows(insertLocation, rowCount, values)	Fügt oberhalb oder unterhalb der Zelle Zeilen hinzu, wobei die Zeile der Zelle als Vorlage verwendet wird. Falls Zeichenfolgenwerte angegeben werden, werden diese in den neu eingefügten Zeilen festgelegt.
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.
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.TableCell Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.TableCellData) 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

body

Ruft das body-Objekt der Zelle ab.

readonly body: Word.Body;

Eigenschaftswert

Word.Body

Hinweise

[ API-Satz: WordApi 1.3 ]

cellIndex

Ruft den Index der Zelle in der Zeile ab.

readonly cellIndex: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApi 1.3 ]

columnWidth

Gibt die Breite der Spalte der Zelle in Punkt an. Dies gilt für einheitliche Tabellen.

columnWidth: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApi 1.3 ]

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

horizontalAlignment

Gibt die horizontale Ausrichtung der Zelle 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 ]

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

parentRow

Ruft die übergeordnete Zeile der Zelle ab.

readonly parentRow: Word.TableRow;

Eigenschaftswert

Word.TableRow

Hinweise

[ API-Satz: WordApi 1.3 ]

parentTable

Ruft die übergeordnete Tabelle der Zelle ab.

readonly parentTable: Word.Table;

Eigenschaftswert

Word.Table

Hinweise

[ API-Satz: WordApi 1.3 ]

rowIndex

Ruft den Index der Zeile mit der Zelle in der Tabelle ab.

readonly rowIndex: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApi 1.3 ]

shadingColor

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

shadingColor: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.3 ]

value

Gibt den Text der Zelle an.

value: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.3 ]

verticalAlignment

Gibt die vertikale Ausrichtung der Zelle 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 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}`);
});

width

Ruft die Breite der Zelle in Punkt ab.

readonly width: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApi 1.3 ]

Details zur Methode

deleteColumn()

Löscht die Spalte, die diese Zelle enthält. Dies gilt für einheitliche Tabellen.

deleteColumn(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApi 1.3 ]

deleteRow()

Löscht die Zeile, die diese Zelle enthält.

deleteRow(): 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 ]

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 ]

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 of the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const firstCell: Word.TableCell = firstTable.getCell(0, 0);
  const borderLocation = "Left";
  const border: Word.TableBorder = firstCell.getBorder(borderLocation);
  border.load(["type", "color", "width"]);
  await context.sync();

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

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 ]

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 ]

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 cell of the first table in the document.
await Word.run(async (context) => {
  const firstTable: Word.Table = context.document.body.tables.getFirst();
  const firstCell: Word.TableCell = firstTable.getCell(0, 0);
  const cellPaddingLocation = "Left";
  const cellPadding = firstCell.getCellPadding(cellPaddingLocation);
  await context.sync();

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

getNext()

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

getNext(): Word.TableCell;

Gibt zurück

Word.TableCell

Hinweise

[ API-Satz: WordApi 1.3 ]

getNextOrNullObject()

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

getNextOrNullObject(): Word.TableCell;

Gibt zurück

Word.TableCell

Hinweise

[ API-Satz: WordApi 1.3 ]

insertColumns(insertLocation, columnCount, values)

Fügt links oder rechts von der Zelle Spalten hinzu, wobei die Spalte der Zelle als Vorlage verwendet wird. Dies gilt für einheitliche Tabellen. Falls Zeichenfolgenwerte angegeben werden, werden diese in den neu eingefügten Zeilen festgelegt.

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

Parameter

insertLocation

before | after | "Before" | "After"

Erforderlich. Es muss "Vor" oder "Nach" sein.

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 ]

insertRows(insertLocation, rowCount, values)

Fügt oberhalb oder unterhalb der Zelle Zeilen hinzu, wobei die Zeile der Zelle als Vorlage verwendet wird. Falls Zeichenfolgenwerte angegeben werden, werden diese in den neu eingefügten Zeilen festgelegt.

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

Parameter

insertLocation

before | after | "Before" | "After"

Erforderlich. Es muss "Vor" oder "Nach" sein.

rowCount

number

Erforderlich. Anzahl der hinzuzufügenden Zeilen.

values

string[][]

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

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.TableCellLoadOptions): Word.TableCell;

Parameter

options

Word.Interfaces.TableCellLoadOptions

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

Gibt zurück

Word.TableCell

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

Parameter

propertyNames

string | string[]

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

Gibt zurück

Word.TableCell

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

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

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

Parameter

properties

Word.Interfaces.TableCellUpdateData

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

Parameter

properties

Word.TableCell

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

toJSON(): Word.Interfaces.TableCellData;

Gibt zurück

Word.Interfaces.TableCellData

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

Gibt zurück

Word.TableCell

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

Gibt zurück

Word.TableCell