Word.CustomXmlNode class

Paket:

word

Stellt einen XML-Knoten in einer Struktur im Dokument dar. Das CustomXmlNode -Objekt ist ein Element des Word. CustomXmlNodeCollection-Objekt.

Extends

OfficeExtension.ClientObject

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Eigenschaften

attributes	Ruft ein CustomXmlNodeCollection -Objekt ab, das die Attribute des aktuellen Elements im aktuellen Knoten darstellt.
baseName	Ruft den Basisnamen des Knotens ohne Namespacepräfix ab, falls vorhanden.
childNodes	Ruft ein CustomXmlNodeCollection -Objekt ab, das alle untergeordneten Elemente des aktuellen Knotens enthält.
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
firstChild	Ruft ein CustomXmlNode -Objekt ab, das dem ersten untergeordneten Element des aktuellen Knotens entspricht. Wenn der Knoten keine untergeordneten Elemente aufweist (oder wenn er nicht vom Typ CustomXmlNodeType.element ist), gibt zurück Nothing.
lastChild	Ruft ein CustomXmlNode -Objekt ab, das dem letzten untergeordneten Element des aktuellen Knotens entspricht. Wenn der Knoten keine untergeordneten Elemente aufweist (oder wenn er nicht vom Typ CustomXmlNodeType.element ist), gibt die -Eigenschaft zurück Nothing.
namespaceUri	Ruft den eindeutigen Adressbezeichner für den Namespace des Knotens ab.
nextSibling	Ruft den nächsten gleichgeordneten Knoten-Knoten (Element, Kommentar oder verarbeitungsanweisung) des aktuellen Knotens ab. Wenn der Knoten das letzte gleichgeordnete Element auf seiner Ebene ist, gibt die -Eigenschaft zurück Nothing.
nodeType	Ruft den Typ des aktuellen Knotens ab.
nodeValue	Gibt den Wert des aktuellen Knotens an.
ownerPart	Ruft das Objekt ab, das die Komponente darstellt, die diesem Knoten zugeordnet ist.
parentNode	Ruft den übergeordneten Elementknoten des aktuellen Knotens ab. Wenn sich der aktuelle Knoten auf der Stammebene befindet, gibt die -Eigenschaft zurück Nothing.
previousSibling	Ruft den vorherigen nebengeordneten-Knoten (Element, Kommentar oder verarbeitungsanweisung) des aktuellen Knotens ab. Wenn der aktuelle Knoten der erste gleichgeordnete Knoten auf seiner Ebene ist, gibt die -Eigenschaft zurück Nothing.
text	Gibt den Text für den aktuellen Knoten an.
xml	Ruft die XML-Darstellung des aktuellen Knotens und seiner untergeordneten Elemente ab.
xpath	Ruft eine Zeichenfolge mit dem kanonisierten XPath für den aktuellen Knoten ab. Wenn der Knoten nicht mehr in das Modell DOM (Document Object) ist, gibt die Eigenschaft eine Fehlermeldung angezeigt.

Methoden

appendChildNode(options)	Fügt einen einzelnen Knoten als letzten untergeordneten Knoten unter dem Kontextelementknoten in der Struktur an.
appendChildSubtree(xml)	Fügt eine Unterstruktur als letzten untergeordneten Knoten unter dem Kontextelementknoten in der Struktur hinzu.
delete()	Löscht den aktuellen Knoten aus der Struktur (einschließlich aller untergeordneter Elemente, soweit vorhanden).
hasChildNodes()	Gibt an, ob der aktuelle Elementknoten über untergeordnete Elementknoten verfügt.
insertNodeBefore(options)	Fügt direkt vor dem Kontextknoten in der Struktur einen neuen Knoten ein.
insertSubtreeBefore(xml, options)	Fügt die angegebene Unterstruktur direkt vor dem Kontextknoten ein.
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.
removeChild(child)	Entfernt den angegebenen untergeordneten Knoten aus der Struktur.
replaceChildNode(oldNode, options)	Entfernt den angegebenen untergeordneten Knoten und ersetzt ihn durch einen anderen Knoten am gleichen Speicherort.
replaceChildSubtree(xml, oldNode)	Entfernt den angegebenen Knoten und ersetzt ihn durch eine andere Unterstruktur am gleichen Speicherort.
selectNodes(xPath)	Markiert eine Auflistung von Knoten mit einem XPath-Ausdruck.
selectSingleNode(xPath)	Ein einzelner Knoten aus einer Auflistung mit einem XPath-Ausdruck ausgewählt.
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.
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.CustomXmlNode Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.CustomXmlNodeData) 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

attributes

Ruft ein CustomXmlNodeCollection -Objekt ab, das die Attribute des aktuellen Elements im aktuellen Knoten darstellt.

readonly attributes: Word.CustomXmlNodeCollection;

Eigenschaftswert

Word.CustomXmlNodeCollection

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

baseName

Ruft den Basisnamen des Knotens ohne Namespacepräfix ab, falls vorhanden.

readonly baseName: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

childNodes

Ruft ein CustomXmlNodeCollection -Objekt ab, das alle untergeordneten Elemente des aktuellen Knotens enthält.

readonly childNodes: Word.CustomXmlNodeCollection;

Eigenschaftswert

Word.CustomXmlNodeCollection

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

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

firstChild

Ruft ein CustomXmlNode -Objekt ab, das dem ersten untergeordneten Element des aktuellen Knotens entspricht. Wenn der Knoten keine untergeordneten Elemente aufweist (oder wenn er nicht vom Typ CustomXmlNodeType.element ist), gibt zurück Nothing.

readonly firstChild: Word.CustomXmlNode;

Eigenschaftswert

Word.CustomXmlNode

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

lastChild

Ruft ein CustomXmlNode -Objekt ab, das dem letzten untergeordneten Element des aktuellen Knotens entspricht. Wenn der Knoten keine untergeordneten Elemente aufweist (oder wenn er nicht vom Typ CustomXmlNodeType.element ist), gibt die -Eigenschaft zurück Nothing.

readonly lastChild: Word.CustomXmlNode;

Eigenschaftswert

Word.CustomXmlNode

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

namespaceUri

Ruft den eindeutigen Adressbezeichner für den Namespace des Knotens ab.

readonly namespaceUri: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

nextSibling

Ruft den nächsten gleichgeordneten Knoten-Knoten (Element, Kommentar oder verarbeitungsanweisung) des aktuellen Knotens ab. Wenn der Knoten das letzte gleichgeordnete Element auf seiner Ebene ist, gibt die -Eigenschaft zurück Nothing.

readonly nextSibling: Word.CustomXmlNode;

Eigenschaftswert

Word.CustomXmlNode

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

nodeType

Ruft den Typ des aktuellen Knotens ab.

readonly nodeType: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document";

Eigenschaftswert

Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

nodeValue

Gibt den Wert des aktuellen Knotens an.

nodeValue: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

ownerPart

Ruft das Objekt ab, das die Komponente darstellt, die diesem Knoten zugeordnet ist.

readonly ownerPart: Word.CustomXmlPart;

Eigenschaftswert

Word.CustomXmlPart

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

parentNode

Ruft den übergeordneten Elementknoten des aktuellen Knotens ab. Wenn sich der aktuelle Knoten auf der Stammebene befindet, gibt die -Eigenschaft zurück Nothing.

readonly parentNode: Word.CustomXmlNode;

Eigenschaftswert

Word.CustomXmlNode

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

previousSibling

Ruft den vorherigen nebengeordneten-Knoten (Element, Kommentar oder verarbeitungsanweisung) des aktuellen Knotens ab. Wenn der aktuelle Knoten der erste gleichgeordnete Knoten auf seiner Ebene ist, gibt die -Eigenschaft zurück Nothing.

readonly previousSibling: Word.CustomXmlNode;

Eigenschaftswert

Word.CustomXmlNode

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

text

Gibt den Text für den aktuellen Knoten an.

text: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

xml

Ruft die XML-Darstellung des aktuellen Knotens und seiner untergeordneten Elemente ab.

readonly xml: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

xpath

Ruft eine Zeichenfolge mit dem kanonisierten XPath für den aktuellen Knoten ab. Wenn der Knoten nicht mehr in das Modell DOM (Document Object) ist, gibt die Eigenschaft eine Fehlermeldung angezeigt.

readonly xpath: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Details zur Methode

appendChildNode(options)

Fügt einen einzelnen Knoten als letzten untergeordneten Knoten unter dem Kontextelementknoten in der Struktur an.

appendChildNode(options?: Word.CustomXmlAppendChildNodeOptions): OfficeExtension.ClientResult<number>;

Parameter

options

Word.CustomXmlAppendChildNodeOptions

Optional. Die Optionen, die den anzufügenden Knoten definieren.

Gibt zurück

OfficeExtension.ClientResult<number>

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

appendChildSubtree(xml)

Fügt eine Unterstruktur als letzten untergeordneten Knoten unter dem Kontextelementknoten in der Struktur hinzu.

appendChildSubtree(xml: string): OfficeExtension.ClientResult<number>;

Parameter

xml

string

Eine Zeichenfolge, die die XML-Unterstruktur darstellt.

Gibt zurück

OfficeExtension.ClientResult<number>

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

delete()

Löscht den aktuellen Knoten aus der Struktur (einschließlich aller untergeordneter Elemente, soweit vorhanden).

delete(): void;

Gibt zurück

void

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

hasChildNodes()

Gibt an, ob der aktuelle Elementknoten über untergeordnete Elementknoten verfügt.

hasChildNodes(): OfficeExtension.ClientResult<boolean>;

Gibt zurück

OfficeExtension.ClientResult<boolean>

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

insertNodeBefore(options)

Fügt direkt vor dem Kontextknoten in der Struktur einen neuen Knoten ein.

insertNodeBefore(options?: Word.CustomXmlInsertNodeBeforeOptions): OfficeExtension.ClientResult<number>;

Parameter

options

Word.CustomXmlInsertNodeBeforeOptions

Optional. Die Optionen, die den einzufügenden Knoten definieren.

Gibt zurück

OfficeExtension.ClientResult<number>

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

insertSubtreeBefore(xml, options)

Fügt die angegebene Unterstruktur direkt vor dem Kontextknoten ein.

insertSubtreeBefore(xml: string, options?: Word.CustomXmlInsertSubtreeBeforeOptions): OfficeExtension.ClientResult<number>;

Parameter

xml

string

Eine Zeichenfolge, die die XML-Unterstruktur darstellt.

options

Word.CustomXmlInsertSubtreeBeforeOptions

Optional. Die verfügbaren Optionen zum Einfügen der Unterstruktur.

Gibt zurück

OfficeExtension.ClientResult<number>

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.CustomXmlNodeLoadOptions): Word.CustomXmlNode;

Parameter

options

Word.Interfaces.CustomXmlNodeLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Word.CustomXmlNode

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

Parameter

propertyNames

string | string[]

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

Gibt zurück

Word.CustomXmlNode

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

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.CustomXmlNode

removeChild(child)

Entfernt den angegebenen untergeordneten Knoten aus der Struktur.

removeChild(child: Word.CustomXmlNode): OfficeExtension.ClientResult<number>;

Parameter

child

Word.CustomXmlNode

Der zu entfernende untergeordnete Knoten.

Gibt zurück

OfficeExtension.ClientResult<number>

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

replaceChildNode(oldNode, options)

Entfernt den angegebenen untergeordneten Knoten und ersetzt ihn durch einen anderen Knoten am gleichen Speicherort.

replaceChildNode(oldNode: Word.CustomXmlNode, options?: Word.CustomXmlReplaceChildNodeOptions): OfficeExtension.ClientResult<number>;

Parameter

oldNode

Word.CustomXmlNode

Der zu ersetzende Knoten.

options

Word.CustomXmlReplaceChildNodeOptions

Optional. Die Optionen, die den untergeordneten Knoten definieren, der den alten Knoten ersetzen soll.

Gibt zurück

OfficeExtension.ClientResult<number>

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

replaceChildSubtree(xml, oldNode)

Entfernt den angegebenen Knoten und ersetzt ihn durch eine andere Unterstruktur am gleichen Speicherort.

replaceChildSubtree(xml: string, oldNode: Word.CustomXmlNode): OfficeExtension.ClientResult<number>;

Parameter

xml

string

Eine Zeichenfolge, die die neue Unterstruktur darstellt.

oldNode

Word.CustomXmlNode

Der zu ersetzende Knoten.

Gibt zurück

OfficeExtension.ClientResult<number>

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

selectNodes(xPath)

Markiert eine Auflistung von Knoten mit einem XPath-Ausdruck.

selectNodes(xPath: string): Word.CustomXmlNodeCollection;

Parameter

xPath

string

Der XPath-Ausdruck.

Gibt zurück

Word.CustomXmlNodeCollection

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

selectSingleNode(xPath)

Ein einzelner Knoten aus einer Auflistung mit einem XPath-Ausdruck ausgewählt.

selectSingleNode(xPath: string): Word.CustomXmlNode;

Parameter

xPath

string

Der XPath-Ausdruck.

Gibt zurück

Word.CustomXmlNode

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

Parameter

properties

Word.Interfaces.CustomXmlNodeUpdateData

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

options

OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt 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.CustomXmlNode): void;

Parameter

properties

Word.CustomXmlNode

Gibt zurück

void

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

toJSON(): Word.Interfaces.CustomXmlNodeData;

Gibt zurück

Word.Interfaces.CustomXmlNodeData

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

Gibt zurück

Word.CustomXmlNode

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

Gibt zurück

Word.CustomXmlNode