Word.TableRowCollection class
Enthält die Auflistung der Word des Dokuments. TableRow-Objekte.
- Extends
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 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();
firstTableRow.load(["horizontalAlignment", "verticalAlignment"]);
await context.sync();
console.log(`Details about the alignment of the first table's first row:`, `- Horizontal alignment of every cell in the row: ${firstTableRow.horizontalAlignment}`, `- Vertical alignment of every cell in the row: ${firstTableRow.verticalAlignment}`);
});
Eigenschaften
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. 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
| convert |
Konvertiert Zeilen in einer Tabelle in Text. |
| delete() | Löscht die Tabellenzeilen. |
| distribute |
Passt die Höhe der Zeilen so an, dass sie gleich sind. |
| get |
Ruft die erste Zeile in dieser Sammlung ab. Löst einen Fehler aus |
| get |
Ruft die erste Zeile in dieser Sammlung ab. Wenn diese Auflistung 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 " |
| select() | Wählt die Tabellenzeilen aus. |
| set |
Legt die Höhe der Zellen in einer Tabelle fest. |
| set |
Legt die Höhe der Zellen in einer Tabelle fest. |
| set |
Legt den linken Einzug für die Tabellenzeile fest. |
| set |
Legt den linken Einzug für die Tabellenzeile fest. |
| 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
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
items
Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.
readonly items: Word.TableRow[];Eigenschaftswert
Details zur Methode
convertToText(options)
Konvertiert Zeilen in einer Tabelle in Text.
convertToText(options?: Word.TableConvertToTextOptions): Word.Range;Parameter
- options
- Word.TableConvertToTextOptions
Optional. Ein -Objekt, das die Optionen zum Konvertieren der Tabellenzeilen in Text angibt.
Gibt zurück
Ein Range -Objekt, das den konvertierten Text darstellt.
Hinweise
delete()
Löscht die Tabellenzeilen.
delete(): void;Gibt zurück
void
Hinweise
distributeHeight()
Passt die Höhe der Zeilen so an, dass sie gleich sind.
distributeHeight(): void;Gibt zurück
void
Hinweise
getFirst()
Ruft die erste Zeile in dieser Sammlung ab. Löst einen Fehler aus ItemNotFound , wenn diese Auflistung leer ist.
getFirst(): Word.TableRow;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 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`);
});
getFirstOrNullObject()
Ruft die erste Zeile in dieser Sammlung ab. Wenn diese Auflistung leer ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getFirstOrNullObject(): Word.TableRow;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.TableRowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableRowCollection;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.TableRowCollection;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.TableRowCollection;Parameter
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
select()
Wählt die Tabellenzeilen aus.
select(): 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 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 Zeile in Punkt.
- heightRule
-
"Auto" | "AtLeast" | "Exactly"
Die Regel zum Festlegen der Höhe für die angegebenen Zeilen.
Gibt zurück
void
Hinweise
setLeftIndent(leftIndent, rulerStyle)
Legt den linken Einzug für die Tabellenzeile fest.
setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void;Parameter
- leftIndent
-
number
Der Abstand (in Punkt) zwischen dem aktuellen linken Rand der angegebenen Zeilen und dem gewünschten linken Rand.
- rulerStyle
- Word.RulerStyle
Der anzuwendende Linealstil.
Gibt zurück
void
Hinweise
setLeftIndent(leftIndent, rulerStyle)
Legt den linken Einzug für die Tabellenzeile fest.
setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;Parameter
- leftIndent
-
number
Der Abstand (in Punkt) zwischen dem aktuellen linken Rand der angegebenen Zeilen und dem gewünschten linken Rand.
- rulerStyle
-
"None" | "Proportional" | "FirstColumn" | "SameWidth"
Der anzuwendende Linealstil.
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.) Während das ursprüngliche Word.TableRowCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.TableRowCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.
toJSON(): Word.Interfaces.TableRowCollectionData;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.TableRowCollection;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.TableRowCollection;