Freigeben über

Word.BuildingBlockCollection class

Paket:
word

Stellt eine Auflistung von Word dar. BuildingBlock-Objekte für einen bestimmten Bausteintyp und eine bestimmte Kategorie in einer Vorlage.

Extends
OfficeExtension.ClientObject

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Eigenschaften

context

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

Methoden

add(name, range, description, insertType)

Erstellt einen neuen Baustein und gibt ein BuildingBlock -Objekt zurück.
add(name, range, description, insertType)

Erstellt einen neuen Baustein und gibt ein BuildingBlock -Objekt zurück.
getCount()

Gibt die Anzahl der Elemente in der Auflistung zurück.
getItemAt(index)

Gibt ein BuildingBlock -Objekt zurück, das das angegebene Element in der Auflistung darstellt.
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.BuildingBlockCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.BuildingBlockCollectionData) 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

Word.RequestContext

Details zur Methode

add(name, range, description, insertType)

Erstellt einen neuen Baustein und gibt ein BuildingBlock -Objekt zurück.

add(name: string, range: Word.Range, description: string, insertType: Word.DocPartInsertType): Word.BuildingBlock;

Parameter

name

string

Der Name des Bausteins.

range
Word.Range

Der Bereich, in den der Baustein eingefügt werden soll.

description

string

Die Beschreibung des Bausteins.

insertType
Word.DocPartInsertType

So fügen Sie den Inhalt des Bausteins ein.

Gibt zurück

Word.BuildingBlock

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

add(name, range, description, insertType)

Erstellt einen neuen Baustein und gibt ein BuildingBlock -Objekt zurück.

add(name: string, range: Word.Range, description: string, insertType: "Content" | "Paragraph" | "Page"): Word.BuildingBlock;

Parameter

name

string

Der Name des Bausteins.

range
Word.Range

Der Bereich, in den der Baustein eingefügt werden soll.

description

string

Die Beschreibung des Bausteins.

insertType

"Content" | "Paragraph" | "Page"

So fügen Sie den Inhalt des Bausteins ein.

Gibt zurück

Word.BuildingBlock

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

getCount()

Gibt die Anzahl der Elemente in der Auflistung zurück.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

OfficeExtension.ClientResult<number>

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

getItemAt(index)

Gibt ein BuildingBlock -Objekt zurück, das das angegebene Element in der Auflistung darstellt.

getItemAt(index: number): Word.BuildingBlock;

Parameter

index

number

Der Index des abzurufenden Elements.

Gibt zurück

Word.BuildingBlock

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

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

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Word.BuildingBlockCollection

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

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

Word.BuildingBlockCollection

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

toJSON(): {
            [key: string]: string;
        };

Gibt zurück

{ [key: string]: string; }

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

Gibt zurück

Word.BuildingBlockCollection

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

Gibt zurück

Word.BuildingBlockCollection