Word.TextColumnCollection class
Eine Sammlung von Word. TextColumn-Objekte, die alle Textspalten im Dokument oder einem Abschnitt des Dokuments darstellen.
- Extends
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
| add(options) | Gibt ein |
| get |
Ruft die Richtung ab, in der Text von einer Textspalte zur nächsten fließt. |
| get |
Ruft ab, ob vertikale Linien zwischen allen Spalten im |
| get |
Ruft ab, ob die Textspalten in gleichen Abständen angeordnet sind. |
| 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 |
Ordnet Text in der angegebenen Anzahl von Textspalten an. |
| set |
Legt die Richtung fest, in der Text von einer Textspalte zur nächsten fließt. |
| set |
Legt die Richtung fest, in der Text von einer Textspalte zur nächsten fließt. |
| set |
Legt fest, ob vertikale Linien zwischen allen Spalten im |
| set |
Legt fest, ob die Textspalten in gleichen Abständen angeordnet sind. |
| 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.TextColumn[];Eigenschaftswert
Details zur Methode
add(options)
Gibt ein TextColumn Objekt zurück, das eine neue Textspalte darstellt, die einem Abschnitt oder Dokument hinzugefügt wurde.
add(options?: Word.TextColumnAddOptions): Word.TextColumn;Parameter
- options
- Word.TextColumnAddOptions
Optional. Optionen zum Konfigurieren der neuen Textspalte.
Gibt zurück
Ein TextColumn Objekt, das eine neue Textspalte darstellt, die dem Dokument hinzugefügt wurde.
Hinweise
getFlowDirection()
Ruft die Richtung ab, in der Text von einer Textspalte zur nächsten fließt.
getFlowDirection(): OfficeExtension.ClientResult<Word.FlowDirection>;Gibt zurück
Hinweise
getHasLineBetween()
Ruft ab, ob vertikale Linien zwischen allen Spalten im TextColumnCollection Objekt angezeigt werden.
getHasLineBetween(): OfficeExtension.ClientResult<boolean>;Gibt zurück
OfficeExtension.ClientResult<boolean>
Hinweise
getIsEvenlySpaced()
Ruft ab, ob die Textspalten in gleichen Abständen angeordnet sind.
getIsEvenlySpaced(): OfficeExtension.ClientResult<boolean>;Gibt zurück
OfficeExtension.ClientResult<boolean>
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.TextColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TextColumnCollection;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.TextColumnCollection;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.TextColumnCollection;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
setCount(numColumns)
Ordnet Text in der angegebenen Anzahl von Textspalten an.
setCount(numColumns: number): void;Parameter
- numColumns
-
number
Die Anzahl der Spalten, in denen der Text angeordnet werden soll.
Gibt zurück
void
Hinweise
setFlowDirection(value)
Legt die Richtung fest, in der Text von einer Textspalte zur nächsten fließt.
setFlowDirection(value: Word.FlowDirection): void;Parameter
- value
- Word.FlowDirection
Die einzustellende Strömungsrichtung.
Gibt zurück
void
Hinweise
setFlowDirection(value)
Legt die Richtung fest, in der Text von einer Textspalte zur nächsten fließt.
setFlowDirection(value: "LeftToRight" | "RightToLeft"): void;Parameter
- value
-
"LeftToRight" | "RightToLeft"
Die einzustellende Strömungsrichtung.
Gibt zurück
void
Hinweise
setHasLineBetween(value)
Legt fest, ob vertikale Linien zwischen allen Spalten im TextColumnCollection Objekt angezeigt werden.
setHasLineBetween(value: boolean): void;Parameter
- value
-
boolean
true um vertikale Linien zwischen Spalten anzuzeigen.
Gibt zurück
void
Hinweise
setIsEvenlySpaced(value)
Legt fest, ob die Textspalten in gleichen Abständen angeordnet sind.
setIsEvenlySpaced(value: boolean): void;Parameter
- value
-
boolean
true um alle Textspalten im Dokument gleichmäßig zu verteilen.
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.TextColumnCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.TextColumnCollectionData) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung enthält.
toJSON(): Word.Interfaces.TextColumnCollectionData;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.TextColumnCollection;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.TextColumnCollection;