Word.TableCell class
Stellt eine Tabellenzelle in einem Word Dokument dar.
- Extends
Hinweise
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);
});
Eigenschaften
| body | Ruft das body-Objekt der Zelle ab. |
| cell |
Ruft den Index der Zelle in der Zeile ab. |
| column |
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. |
| horizontal |
Gibt die horizontale Ausrichtung der Zelle an. Der Wert kann "Left", "Centered", "Right" oder "Justified" lauten. |
| parent |
Ruft die übergeordnete Zeile der Zelle ab. |
| parent |
Ruft die übergeordnete Tabelle der Zelle ab. |
| row |
Ruft den Index der Zeile mit der Zelle in der Tabelle ab. |
| shading |
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. |
| vertical |
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
| delete |
Löscht die Spalte, die diese Zelle enthält. Dies gilt für einheitliche Tabellen. |
| delete |
Löscht die Zeile, die diese Zelle enthält. |
| get |
Ruft die Rahmenart für den angegebenen Rahmen ab. |
| get |
Ruft die Rahmenart für den angegebenen Rahmen ab. |
| get |
Ruft den Textabstand in Punkt ab. |
| get |
Ruft den Textabstand in Punkt ab. |
| get |
Ruft die nächste Zelle ab. Löst einen Fehler aus |
| get |
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 |
| insert |
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. |
| insert |
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 " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| 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. |
| set |
Legt den Textabstand in Punkt fest. |
| set |
Legt den Textabstand in Punkt fest. |
| split(row |
Teilt die Zelle in die angegebene Anzahl von Zeilen und Spalten auf. |
| toJSON() | Überschreibt die JavaScript-Methode |
| 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 |
| 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 |
Details zur Eigenschaft
body
Ruft das body-Objekt der Zelle ab.
readonly body: Word.Body;Eigenschaftswert
Hinweise
cellIndex
Ruft den Index der Zelle in der Zeile ab.
readonly cellIndex: number;Eigenschaftswert
number
Hinweise
columnWidth
Gibt die Breite der Spalte der Zelle in Punkt an. Dies gilt für einheitliche Tabellen.
columnWidth: number;Eigenschaftswert
number
Hinweise
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
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
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 = context.document.body.tables.getFirst();
const firstCell = firstTable.getCell(0, 0);
firstCell.load(["horizontalAlignment", "verticalAlignment"]);
await context.sync();
console.log(`Details about the alignment of the first table's first cell:`);
console.log(`- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`);
console.log(`- Vertical alignment of the cell's content: ${firstCell.verticalAlignment}`);
});
parentRow
Ruft die übergeordnete Zeile der Zelle ab.
readonly parentRow: Word.TableRow;Eigenschaftswert
Hinweise
parentTable
Ruft die übergeordnete Tabelle der Zelle ab.
readonly parentTable: Word.Table;Eigenschaftswert
Hinweise
rowIndex
Ruft den Index der Zeile mit der Zelle in der Tabelle ab.
readonly rowIndex: number;Eigenschaftswert
number
Hinweise
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
value
Gibt den Text der Zelle an.
value: string;Eigenschaftswert
string
Hinweise
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
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 = context.document.body.tables.getFirst();
const firstCell = firstTable.getCell(0, 0);
firstCell.load(["horizontalAlignment", "verticalAlignment"]);
await context.sync();
console.log(`Details about the alignment of the first table's first cell:`);
console.log(`- Horizontal alignment of the cell's content: ${firstCell.horizontalAlignment}`);
console.log(`- Vertical alignment of the cell's content: ${firstCell.verticalAlignment}`);
});
width
Ruft die Breite der Zelle in Punkt ab.
readonly width: number;Eigenschaftswert
number
Hinweise
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
deleteRow()
Löscht die Zeile, die diese Zelle enthält.
deleteRow(): void;Gibt zurück
void
Hinweise
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
Hinweise
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
Hinweise
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 = context.document.body.tables.getFirst();
const firstCell = firstTable.getCell(0, 0);
const borderLocation = "Left";
const border = 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:`);
console.log(`- Color: ${border.color}`);
console.log(`- Type: ${border.type}`);
console.log(`- 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
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
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 = context.document.body.tables.getFirst();
const firstCell = 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
Hinweise
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
Hinweise
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
- 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
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
- 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
Hinweise
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
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
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
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
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
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
split(rowCount, columnCount)
Teilt die Zelle in die angegebene Anzahl von Zeilen und Spalten auf.
split(rowCount: number, columnCount: number): void;Parameter
- rowCount
-
number
Erforderlich. Die Anzahl der Zeilen, in die aufgeteilt werden soll. Muss ein Divisor der Anzahl der zugrunde liegenden Zeilen sein.
- columnCount
-
number
Erforderlich. Die Anzahl der Spalten, in die aufgeteilt werden soll.
Gibt zurück
void
Hinweise
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 TableCell-Objekt ist ein API-Objekt. Die toJSON Methode gibt 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
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
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
Office Add-ins
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für