Freigeben über


Word.HtmlDivision class

Extends

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Eigenschaften

context

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

htmlDivisions
leftIndent

Gibt den linken Einzugswert (in Punkt) für diese HTML-Division an.

range

Ruft ein Range -Objekt ab, das den Teil eines Dokuments darstellt, der in dieser HTML-Division enthalten ist.

rightIndent

Gibt den rechten Einzug (in Punkt) für diese HTML-Division an.

spaceAfter

Gibt den Abstand (in Punkt) nach dieser HTML-Division an.

spaceBefore

Gibt den Abstand (in Punkt) vor dieser HTML-Division an.

Methoden

delete()

Löscht diese HTML-Division.

htmlDivisionParent(levelsUp)

Gibt ein HtmlDivision -Objekt zurück, das eine übergeordnete Division der aktuellen HTML-Division darstellt.

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.

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

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.

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

htmlDivisions

readonly htmlDivisions: Word.HtmlDivisionCollection;

Eigenschaftswert

leftIndent

Gibt den linken Einzugswert (in Punkt) für diese HTML-Division an.

leftIndent: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

range

Ruft ein Range -Objekt ab, das den Teil eines Dokuments darstellt, der in dieser HTML-Division enthalten ist.

readonly range: Word.Range;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

rightIndent

Gibt den rechten Einzug (in Punkt) für diese HTML-Division an.

rightIndent: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

spaceAfter

Gibt den Abstand (in Punkt) nach dieser HTML-Division an.

spaceAfter: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

spaceBefore

Gibt den Abstand (in Punkt) vor dieser HTML-Division an.

spaceBefore: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

Details zur Methode

delete()

Löscht diese HTML-Division.

delete(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

htmlDivisionParent(levelsUp)

Gibt ein HtmlDivision -Objekt zurück, das eine übergeordnete Division der aktuellen HTML-Division darstellt.

htmlDivisionParent(levelsUp?: number): Word.HtmlDivision;

Parameter

levelsUp

number

Optional. Die Anzahl der Ebenen, die zum Abrufen der übergeordneten Division hochzugehen sind.

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.4 ]

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.HtmlDivisionLoadOptions): Word.HtmlDivision;

Parameter

options
Word.Interfaces.HtmlDivisionLoadOptions

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

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

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

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.HtmlDivision Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.HtmlDivisionData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Word.Interfaces.HtmlDivisionData;

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

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

Gibt zurück