Word.TableCellCollection class
Enthält die Sammlung der Word des Dokuments. TableCell-Objekte.
- Extends
Hinweise
Verwendet von
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
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| items | Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab. |
Methoden
| auto |
Ändert die Breite einer Tabellenspalte und passt diese an die Breite des Texts an, ohne die Art zu ändern, wie der Text in den Zellen umbrochen wird. |
| delete(shift |
Löscht die Tabellenzellen und steuert optional, wie die verbleibenden Zellen verschoben werden. |
| delete(shift |
Löscht die Tabellenzellen und steuert optional, wie die verbleibenden Zellen verschoben werden. |
| distribute |
Legt eine gleiche Höhe für die angegebenen Zellen fest. |
| distribute |
Legt eine gleiche Breite für die angegebenen Zellen fest. |
| get |
Ruft die erste Tabellenzelle in dieser Sammlung ab. Gibt einen |
| get |
Ruft die erste Tabellenzelle in dieser Sammlung ab. Wenn diese Sammlung leer ist, gibt diese Methode ein Objekt zurück, dessen |
| 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 " |
| merge() | Führt die angegebenen Zellen in einer einzigen Zelle zusammen. |
| set |
Legt die Höhe der Zellen in einer Tabelle fest. |
| set |
Legt die Höhe der Zellen in einer Tabelle fest. |
| set |
Legt die Breite der Zellen in einer Tabelle fest. |
| set |
Legt die Breite der Zellen in einer Tabelle fest. |
| split(options) | Teilt diesen Bereich von Tabellenzellen. |
| 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 aufrufübergreifend |
| 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 einen Aufruf durchführen |
Details zur Eigenschaft
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
items
Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
readonly items: Word.TableCell[];Eigenschaftswert
Details zur Methode
autoFit()
Ändert die Breite einer Tabellenspalte und passt diese an die Breite des Texts an, ohne die Art zu ändern, wie der Text in den Zellen umbrochen wird.
autoFit(): void;Gibt zurück
void
Hinweise
delete(shiftCells)
Löscht die Tabellenzellen und steuert optional, wie die verbleibenden Zellen verschoben werden.
delete(shiftCells?: Word.DeleteCells): void;Parameter
- shiftCells
- Word.DeleteCells
Optional. Gibt an, wie die verbleibenden Zellen nach dem Löschen verschoben werden. Der Standardwert ist shiftLeft.
Gibt zurück
void
Hinweise
delete(shiftCells)
Löscht die Tabellenzellen und steuert optional, wie die verbleibenden Zellen verschoben werden.
delete(shiftCells?: "ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"): void;Parameter
- shiftCells
-
"ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"
Optional. Gibt an, wie die verbleibenden Zellen nach dem Löschen verschoben werden. Der Standardwert ist shiftLeft.
Gibt zurück
void
Hinweise
distributeHeight()
Legt eine gleiche Höhe für die angegebenen Zellen fest.
distributeHeight(): void;Gibt zurück
void
Hinweise
distributeWidth()
Legt eine gleiche Breite für die angegebenen Zellen fest.
distributeWidth(): void;Gibt zurück
void
Hinweise
getFirst()
Ruft die erste Tabellenzelle in dieser Sammlung ab. Gibt einen ItemNotFound Fehler aus, wenn diese Sammlung leer ist.
getFirst(): Word.TableCell;Gibt zurück
Hinweise
getFirstOrNullObject()
Ruft die erste Tabellenzelle in dieser Sammlung ab. Wenn diese Sammlung leer ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getFirstOrNullObject(): Word.TableCell;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.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCellCollection;Parameter
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
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.TableCellCollection;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?: OfficeExtension.LoadOption): Word.TableCellCollection;Parameter
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
merge()
Führt die angegebenen Zellen in einer einzigen Zelle zusammen.
merge(): void;Gibt zurück
void
Hinweise
setHeight(rowHeight, heightRule)
Legt die Höhe der Zellen in einer Tabelle fest.
setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void;Parameter
- rowHeight
-
number
Die Höhe der festzulegenden Zeile in Punkt.
- heightRule
- Word.RowHeightRule
Die Regel zum Festlegen der Höhe für die angegebenen Zeilen.
Gibt zurück
void
Hinweise
setHeight(rowHeight, heightRule)
Legt die Höhe der Zellen in einer Tabelle fest.
setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void;Parameter
- rowHeight
-
number
Die Höhe der festzulegenden Zeile in Punkt.
- heightRule
-
"Auto" | "AtLeast" | "Exactly"
Die Regel zum Festlegen der Höhe für die angegebenen Zeilen.
Gibt zurück
void
Hinweise
setWidth(columnWidth, rulerStyle)
Legt die Breite der Zellen in einer Tabelle fest.
setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void;Parameter
- columnWidth
-
number
Die Breite der festzulegenden Zeile in Punkt.
- rulerStyle
- Word.RulerStyle
Der anzuwendende Linealstil.
Gibt zurück
void
Hinweise
setWidth(columnWidth, rulerStyle)
Legt die Breite der Zellen in einer Tabelle fest.
setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;Parameter
- columnWidth
-
number
Die Breite der festzulegenden Zeile in Punkt.
- rulerStyle
-
"None" | "Proportional" | "FirstColumn" | "SameWidth"
Der anzuwendende Linealstil.
Gibt zurück
void
Hinweise
split(options)
Teilt diesen Bereich von Tabellenzellen.
split(options?: Word.TableCellCollectionSplitOptions): void;Parameter
Optional. Optionen zum Teilen von Tabellenzellen.
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 sie übergeben wird.) Während das ursprüngliche Word.TableCellCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.TableCellCollectionData) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung enthält.
toJSON(): Word.Interfaces.TableCellCollectionData;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 aufrufübergreifend .sync 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 ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Sammlung ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.
track(): Word.TableCellCollection;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 einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.TableCellCollection;