Word.XmlNode class
Stellt einen einzelnen XML-Knoten dar, der auf das Dokument angewendet wird.
- Extends
Hinweise
Eigenschaften
| attributes | Ruft die Attribute für diesen XML-Knoten ab. Gibt zurück |
| base |
Ruft den Namen des Elements ohne Präfix ab. |
| child |
Ruft die untergeordneten Elemente dieses XML-Knotens ab. Gibt eine leere Auflistung zurück, wenn der Knotentyp ist |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| first |
Ruft den ersten untergeordneten Knoten ab, wenn es sich um einen übergeordneten Knoten handelt. Gibt zurück |
| has |
Ruft ab, ob dieser XML-Knoten über untergeordnete Knoten verfügt. Gibt für Attributknoten immer zurück |
| last |
Ruft den letzten untergeordneten Knoten ab, wenn es sich um einen übergeordneten Knoten handelt. Gibt zurück |
| level | Ruft ab, ob dieses XML-Element Teil eines Absatzes ist, ein Absatz ist oder in einer Tabellenzelle enthalten ist oder eine Tabellenzeile enthält. Gibt zurück |
| namespace |
Ruft den URI (Uniform Resource Identifier) des Schemanamespace für diesen XML-Knoten ab. |
| next |
Ruft das nächste Element im Dokument ab, das sich auf der gleichen Ebene wie dieser XML-Knoten befindet. Gibt zurück |
| owner |
Ruft das übergeordnete Dokument dieses XML-Knotens ab. |
| parent |
Ruft das übergeordnete Element dieses XML-Knotens ab. |
| placeholder |
Gibt den Text an, der für dieses Element angezeigt wird, wenn es keinen Text enthält. Gilt nur für Elementknoten, nicht für Attributknoten. |
| previous |
Ruft das vorherige Element im Dokument ab, das sich auf der gleichen Ebene wie dieser XML-Knoten befindet. Gibt zurück |
| range | Ruft den Teil eines Dokuments ab, der in diesem XML-Knoten enthalten ist. Gibt zurück |
| text | Gibt den Text an, der im XML-Element enthalten ist. Gibt eine leere Zeichenfolge zurück, wenn der Knotentyp ist |
| type | Ruft den Typ des Knotens ab. |
| validation |
Ruft die Beschreibung für einen Validierungsfehler für dieses |
| validation |
Ruft ab, ob dieses Element gemäß dem angefügten Schema gültig ist. Für Attributknoten ist möglicherweise nicht sinnvoll. |
| value | Gibt den Wert dieses XML-Knotens an. Für Elementknoten stellt den Textinhalt dar; für Attributknoten, stellt den Attributwert dar. |
Methoden
| copy() | Kopiert diesen XML-Knoten mit Ausnahme von XML-Markup in die Zwischenablage. Kopiert bei Attributknoten nur den Attributwert als Text. |
| cut() | Entfernt diesen XML-Knoten aus dem Dokument und platziert ihn in der Zwischenablage. Entfernt bei Attributknoten das Attribut aus dem übergeordneten Element und kopiert nur den Attributwert als Text in die Zwischenablage. |
| delete() | Löscht den XML-Knoten aus dem XML-Dokument. Entfernt bei Elementknoten das gesamte Element und seinen Inhalt. für Attributknoten entfernt das Attribut aus dem übergeordneten Element. |
| 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 " |
| remove |
Entfernt ein untergeordnetes Element aus diesem XML-Knoten. Diese Methode hat keine Auswirkung, wenn der Knotentyp ist |
| select |
Gibt alle untergeordneten Elemente zurück, die dem XPath-Parameter entsprechen, in der Reihenfolge, in der sie in diesem XML-Knoten angezeigt werden. Gibt zurück |
| select |
Gibt das erste untergeordnete Element zurück, das dem XPath-Parameter innerhalb dieses XML-Knotens entspricht. Gibt zurück |
| set |
Ändert den Validierungsfehlertext, der einem Benutzer für diesen XML-Knoten angezeigt wird, und ob Word erzwingen soll, den Knoten als ungültig zu melden. Für Attributknoten ist möglicherweise nicht sinnvoll. |
| set |
Ändert den Validierungsfehlertext, der einem Benutzer für diesen XML-Knoten angezeigt wird, und ob Word erzwingen soll, den Knoten als ungültig zu melden. Für Attributknoten ist möglicherweise nicht sinnvoll. |
| 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 über |
| 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 |
| validate() | Überprüft diesen XML-Knoten anhand der XML-Schemas, die an das Dokument angefügt sind. Für Attributknoten ist möglicherweise nicht sinnvoll. |
Details zur Eigenschaft
attributes
Ruft die Attribute für diesen XML-Knoten ab. Gibt zurück null , wenn der Knotentyp ist attribute.
readonly attributes: Word.XmlNodeCollection;Eigenschaftswert
Hinweise
baseName
Ruft den Namen des Elements ohne Präfix ab.
readonly baseName: string;Eigenschaftswert
string
Hinweise
childNodes
Ruft die untergeordneten Elemente dieses XML-Knotens ab. Gibt eine leere Auflistung zurück, wenn der Knotentyp ist attribute.
readonly childNodes: Word.XmlNodeCollection;Eigenschaftswert
Hinweise
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
firstChild
Ruft den ersten untergeordneten Knoten ab, wenn es sich um einen übergeordneten Knoten handelt. Gibt zurück null , wenn der Knotentyp ist attribute.
readonly firstChild: Word.XmlNode;Eigenschaftswert
Hinweise
hasChildNodes
Ruft ab, ob dieser XML-Knoten über untergeordnete Knoten verfügt. Gibt für Attributknoten immer zurück false , da sie keine untergeordneten Elemente haben können.
readonly hasChildNodes: boolean;Eigenschaftswert
boolean
Hinweise
lastChild
Ruft den letzten untergeordneten Knoten ab, wenn es sich um einen übergeordneten Knoten handelt. Gibt zurück null , wenn der Knotentyp ist attribute.
readonly lastChild: Word.XmlNode;Eigenschaftswert
Hinweise
level
Ruft ab, ob dieses XML-Element Teil eines Absatzes ist, ein Absatz ist oder in einer Tabellenzelle enthalten ist oder eine Tabellenzeile enthält. Gibt zurück null , wenn der Knotentyp ist attribute.
readonly level: Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | "Cell";Eigenschaftswert
Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | "Cell"
Hinweise
namespaceUri
Ruft den URI (Uniform Resource Identifier) des Schemanamespace für diesen XML-Knoten ab.
readonly namespaceUri: string;Eigenschaftswert
string
Hinweise
nextSibling
Ruft das nächste Element im Dokument ab, das sich auf der gleichen Ebene wie dieser XML-Knoten befindet. Gibt zurück null , wenn der Knotentyp ist attribute.
readonly nextSibling: Word.XmlNode;Eigenschaftswert
Hinweise
ownerDocument
Ruft das übergeordnete Dokument dieses XML-Knotens ab.
readonly ownerDocument: Word.Document;Eigenschaftswert
Hinweise
parentNode
Ruft das übergeordnete Element dieses XML-Knotens ab.
readonly parentNode: Word.XmlNode;Eigenschaftswert
Hinweise
placeholderText
Gibt den Text an, der für dieses Element angezeigt wird, wenn es keinen Text enthält. Gilt nur für Elementknoten, nicht für Attributknoten.
placeholderText: string;Eigenschaftswert
string
Hinweise
previousSibling
Ruft das vorherige Element im Dokument ab, das sich auf der gleichen Ebene wie dieser XML-Knoten befindet. Gibt zurück null , wenn der Knotentyp ist attribute.
readonly previousSibling: Word.XmlNode;Eigenschaftswert
Hinweise
range
Ruft den Teil eines Dokuments ab, der in diesem XML-Knoten enthalten ist. Gibt zurück null , wenn der Knotentyp ist attribute.
readonly range: Word.Range;Eigenschaftswert
Hinweise
text
Gibt den Text an, der im XML-Element enthalten ist. Gibt eine leere Zeichenfolge zurück, wenn der Knotentyp ist attribute.
text: string;Eigenschaftswert
string
Hinweise
type
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Ruft den Typ des Knotens ab.
readonly type: Word.XmlNodeType | "Element" | "Attribute";Eigenschaftswert
Word.XmlNodeType | "Element" | "Attribute"
Hinweise
validationErrorText
Ruft die Beschreibung für einen Validierungsfehler für dieses XmlNode Objekt ab. Für Attributknoten ist möglicherweise nicht sinnvoll.
readonly validationErrorText: string;Eigenschaftswert
string
Hinweise
validationStatus
Ruft ab, ob dieses Element gemäß dem angefügten Schema gültig ist. Für Attributknoten ist möglicherweise nicht sinnvoll.
readonly validationStatus: Word.XmlValidationStatus | "Ok" | "Custom";Eigenschaftswert
Word.XmlValidationStatus | "Ok" | "Custom"
Hinweise
value
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt den Wert dieses XML-Knotens an. Für Elementknoten stellt den Textinhalt dar; für Attributknoten, stellt den Attributwert dar.
value: string;Eigenschaftswert
string
Hinweise
Details zur Methode
copy()
Kopiert diesen XML-Knoten mit Ausnahme von XML-Markup in die Zwischenablage. Kopiert bei Attributknoten nur den Attributwert als Text.
copy(): void;Gibt zurück
void
Hinweise
cut()
Entfernt diesen XML-Knoten aus dem Dokument und platziert ihn in der Zwischenablage. Entfernt bei Attributknoten das Attribut aus dem übergeordneten Element und kopiert nur den Attributwert als Text in die Zwischenablage.
cut(): void;Gibt zurück
void
Hinweise
delete()
Löscht den XML-Knoten aus dem XML-Dokument. Entfernt bei Elementknoten das gesamte Element und seinen Inhalt. für Attributknoten entfernt das Attribut aus dem übergeordneten Element.
delete(): void;Gibt zurück
void
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.XmlNodeLoadOptions): Word.XmlNode;Parameter
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.XmlNode;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.XmlNode;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
removeChild(childElement)
Entfernt ein untergeordnetes Element aus diesem XML-Knoten. Diese Methode hat keine Auswirkung, wenn der Knotentyp ist attribute (da Attributknoten keine untergeordneten Elemente haben).
removeChild(childElement: Word.XmlNode): void;Parameter
- childElement
- Word.XmlNode
Das zu entfernende untergeordnete Element.
Gibt zurück
void
Hinweise
selectNodes(xPath, options)
Gibt alle untergeordneten Elemente zurück, die dem XPath-Parameter entsprechen, in der Reihenfolge, in der sie in diesem XML-Knoten angezeigt werden. Gibt zurück null , wenn der Knotentyp ist attribute (da Attributknoten keine untergeordneten Elemente zum Durchsuchen haben).
selectNodes(xPath: string, options?: Word.SelectNodesOptions): Word.XmlNodeCollection;Parameter
- xPath
-
string
Der auszuwertende XPath-Ausdruck.
- options
- Word.SelectNodesOptions
Optional. Konfigurationsoptionen für die XPath-Suche.
Gibt zurück
Eine Auflistung von XML-Knoten, die dem XPath-Ausdruck entsprechen.
Hinweise
selectSingleNode(xPath, options)
Gibt das erste untergeordnete Element zurück, das dem XPath-Parameter innerhalb dieses XML-Knotens entspricht. Gibt zurück null , wenn der Knotentyp ist attribute (da Attributknoten keine untergeordneten Elemente zum Durchsuchen haben).
selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): Word.XmlNode;Parameter
- xPath
-
string
Der auszuwertende XPath-Ausdruck.
- options
- Word.SelectSingleNodeOptions
Optional. Konfigurationsoptionen für die XPath-Suche.
Gibt zurück
Der erste XML-Knoten, der mit dem XPath-Ausdruck übereinstimmt, oder null , wenn keine Übereinstimmung gefunden wird.
Hinweise
setValidationError(status, options)
Ändert den Validierungsfehlertext, der einem Benutzer für diesen XML-Knoten angezeigt wird, und ob Word erzwingen soll, den Knoten als ungültig zu melden. Für Attributknoten ist möglicherweise nicht sinnvoll.
setValidationError(status: Word.XmlValidationStatus, options?: Word.XmlNodeSetValidationErrorOptions): void;Parameter
- status
- Word.XmlValidationStatus
Die festzulegende status.
Optional. Konfigurationsoptionen zum Festlegen des Überprüfungsfehlers.
Gibt zurück
void
Hinweise
setValidationError(status, options)
Ändert den Validierungsfehlertext, der einem Benutzer für diesen XML-Knoten angezeigt wird, und ob Word erzwingen soll, den Knoten als ungültig zu melden. Für Attributknoten ist möglicherweise nicht sinnvoll.
setValidationError(status: "Ok" | "Custom", options?: Word.XmlNodeSetValidationErrorOptions): void;Parameter
- status
-
"Ok" | "Custom"
Die festzulegende status.
Optional. Konfigurationsoptionen zum Festlegen des Überprüfungsfehlers.
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 das Objekt übergeben wird.) Während das ursprüngliche Word.XmlNode Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.XmlNodeData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Word.Interfaces.XmlNodeData;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.XmlNode;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.XmlNode;Gibt zurück
validate()
Überprüft diesen XML-Knoten anhand der XML-Schemas, die an das Dokument angefügt sind. Für Attributknoten ist möglicherweise nicht sinnvoll.
validate(): void;Gibt zurück
void