Word.TableColumn class

Stellt eine Tabellenspalte in einem Word-Dokument dar.

Extends

Eigenschaften

borders

Gibt ein BorderUniversalCollection Objekt zurück, das alle Rahmen für die Tabellenspalte darstellt.

columnIndex

Gibt die Position dieser Spalte in einer Auflistung zurück.

context

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

isFirst

Gibt zurück true , ob die Spalte oder Zeile die erste in der Tabelle ist, false andernfalls nicht.

isLast

Gibt zurück true , ob die Spalte oder Zeile die letzte in der Tabelle ist, false andernfalls nicht.

nestingLevel

Gibt die Schachtelungsebene der Spalte zurück.

preferredWidth

Gibt die bevorzugte Breite (in Punkten oder als Prozentsatz der Fensterbreite) für die Spalte an. Die Maßeinheit kann durch die preferredWidthType Eigenschaft angegeben werden.

preferredWidthType

Gibt die bevorzugte Maßeinheit für die Breite der Tabellenspalte an.

shading

Gibt ein ShadingUniversal Objekt zurück, das auf die Schattierungsformatierung für die Spalte verweist.

width

Gibt die Breite der Spalte in Punkt an.

Methoden

autoFit()

Ändert die Breite der Tabellenspalte, um die Breite des Texts aufzunehmen, ohne den Textumbruch in den Zellen zu ändern.

delete()

Löscht die Spalte.

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.

select()

Markiert die Tabellenspalte.

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.

setWidth(columnWidth, rulerStyle)

Legt die Breite der Spalte in einer Tabelle fest.

setWidth(columnWidth, rulerStyle)

Legt die Breite der Spalte in einer Tabelle fest.

sort()

Sortiert die Tabellenspalte.

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.TableColumn Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.TableColumnData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts 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 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.

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.

Details zur Eigenschaft

borders

Gibt ein BorderUniversalCollection Objekt zurück, das alle Rahmen für die Tabellenspalte darstellt.

readonly borders: Word.BorderUniversalCollection;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

columnIndex

Gibt die Position dieser Spalte in einer Auflistung zurück.

readonly columnIndex: number;

Eigenschaftswert

number

Hinweise

API-Satz: WordApiDesktop 1.3

context

Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

isFirst

Gibt zurück true , ob die Spalte oder Zeile die erste in der Tabelle ist, false andernfalls nicht.

readonly isFirst: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApiDesktop 1.3

isLast

Gibt zurück true , ob die Spalte oder Zeile die letzte in der Tabelle ist, false andernfalls nicht.

readonly isLast: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApiDesktop 1.3

nestingLevel

Gibt die Schachtelungsebene der Spalte zurück.

readonly nestingLevel: number;

Eigenschaftswert

number

Hinweise

API-Satz: WordApiDesktop 1.3

preferredWidth

Gibt die bevorzugte Breite (in Punkten oder als Prozentsatz der Fensterbreite) für die Spalte an. Die Maßeinheit kann durch die preferredWidthType Eigenschaft angegeben werden.

preferredWidth: number;

Eigenschaftswert

number

Hinweise

API-Satz: WordApiDesktop 1.3

preferredWidthType

Gibt die bevorzugte Maßeinheit für die Breite der Tabellenspalte an.

preferredWidthType: Word.PreferredWidthType | "Auto" | "Percent" | "Points";

Eigenschaftswert

Word.PreferredWidthType | "Auto" | "Percent" | "Points"

Hinweise

API-Satz: WordApiDesktop 1.3

shading

Gibt ein ShadingUniversal Objekt zurück, das auf die Schattierungsformatierung für die Spalte verweist.

readonly shading: Word.ShadingUniversal;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

width

Gibt die Breite der Spalte in Punkt an.

width: number;

Eigenschaftswert

number

Hinweise

API-Satz: WordApiDesktop 1.3

Details zur Methode

autoFit()

Ändert die Breite der Tabellenspalte, um die Breite des Texts aufzunehmen, ohne den Textumbruch in den Zellen zu ändern.

autoFit(): void;

Gibt zurück

void

Hinweise

API-Satz: WordApiDesktop 1.3

delete()

Löscht die Spalte.

delete(): void;

Gibt zurück

void

Hinweise

API-Satz: WordApiDesktop 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.TableColumnLoadOptions): Word.TableColumn;

Parameter

options
Word.Interfaces.TableColumnLoadOptions

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

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

Parameter

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

select()

Markiert die Tabellenspalte.

select(): void;

Gibt zurück

void

Hinweise

API-Satz: WordApiDesktop 1.3

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

Parameter

properties
Word.Interfaces.TableColumnUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options
OfficeExtension.UpdateOptions

Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt 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.TableColumn): void;

Parameter

properties
Word.TableColumn

Gibt zurück

void

setWidth(columnWidth, rulerStyle)

Legt die Breite der Spalte in einer Tabelle fest.

setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void;

Parameter

columnWidth

number

Die festzulegende Breite.

rulerStyle
Word.RulerStyle

Der anzuwendende Linealstil.

Gibt zurück

void

Hinweise

API-Satz: WordApiDesktop 1.3

setWidth(columnWidth, rulerStyle)

Legt die Breite der Spalte in einer Tabelle fest.

setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void;

Parameter

columnWidth

number

Die festzulegende Breite.

rulerStyle

"None" | "Proportional" | "FirstColumn" | "SameWidth"

Der anzuwendende Linealstil.

Gibt zurück

void

Hinweise

API-Satz: WordApiDesktop 1.3

sort()

Sortiert die Tabellenspalte.

sort(): void;

Gibt zurück

void

Hinweise

API-Satz: WordApiDesktop 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 sie übergeben wird.) Während das ursprüngliche Word.TableColumn Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.TableColumnData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.

toJSON(): Word.Interfaces.TableColumnData;

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

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

Gibt zurück