Word.XmlNode class

Obtient les attributs de ce nœud XML. Renvoie null si le type de nœud est attribute.

readonly attributes: Word.XmlNodeCollection;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Récupère le nom de l’élément sans préfixe.

readonly baseName: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Récupère les éléments enfants de ce nœud XML. Renvoie une collection vide si le type de nœud est attribute.

readonly childNodes: Word.XmlNodeCollection;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Récupère le premier nœud enfant s’il s’agit d’un nœud parent. Renvoie null si le type de nœud est attribute.

readonly firstChild: Word.XmlNode;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Récupère si ce nœud XML possède des nœuds enfants. Retourne false toujours pour les nœuds d’attribut car ils ne peuvent pas avoir d’enfants.

readonly hasChildNodes: boolean;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Récupère le dernier nœud enfant s’il s’agit d’un nœud parent. Renvoie null si le type de nœud est attribute.

readonly lastChild: Word.XmlNode;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Récupère si cet élément XML fait partie d’un paragraphe, est un paragraphe, est contenu dans une cellule de tableau ou contient une ligne de tableau. Renvoie null si le type de nœud est attribute.

readonly level: Word.XmlNodeLevel | "Inline" | "Paragraph" | "Row" | "Cell";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Obtient l’URI (Uniform Resource Identifier) de l’espace de noms du schéma pour ce nœud XML.

readonly namespaceUri: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Obtient l’élément suivant dans le document qui se trouve au même niveau que ce nœud XML. Renvoie null si le type de nœud est attribute.

readonly nextSibling: Word.XmlNode;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Obtient le document parent de ce nœud XML.

readonly ownerDocument: Word.Document;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Obtient l’élément parent de ce nœud XML.

readonly parentNode: Word.XmlNode;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Spécifie le texte affiché pour cet élément s’il n’en contient pas. S’applique uniquement aux nœuds d’élément, et non aux nœuds d’attribut.

placeholderText: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Obtient l’élément précédent dans le document qui se trouve au même niveau que ce nœud XML. Renvoie null si le type de nœud est attribute.

readonly previousSibling: Word.XmlNode;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Obtient la partie d’un document qui est contenue dans ce nœud XML. Renvoie null si le type de nœud est attribute.

readonly range: Word.Range;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Spécifie le texte contenu dans l’élément XML. Renvoie une chaîne vide si le type de nœud est attribute.

text: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Obtient le type de nœud.

readonly type: Word.XmlNodeType | "Element" | "Attribute";

Valeur de propriété

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

Obtient la description d’une erreur de validation sur cet XmlNode objet. Peut ne pas être significatif pour les nœuds d’attribut.

readonly validationErrorText: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Détermine si cet élément est valide d’après le schéma attaché. Peut ne pas être significatif pour les nœuds d’attribut.

readonly validationStatus: Word.XmlValidationStatus | "Ok" | "Custom";

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.4

Spécifie la valeur de ce nœud XML. Pour les nœuds d’élément, représente le contenu du texte ; pour les nœuds d’attribut, représente la valeur d’attribut.

value: string;

Valeur de propriété

Remarques

Jeu d’API : WordApi BÊTA (PRÉVERSION UNIQUEMENT)

Copie ce nœud XML, à l’exception du balisage XML, dans le Presse-papiers. Pour les nœuds d’attribut, copie uniquement la valeur d’attribut sous forme de texte.

copy(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Supprime ce nœud XML du document et le place dans le Presse-papiers. Pour les nœuds d’attribut, supprime l’attribut de son élément parent et copie uniquement la valeur d’attribut sous forme de texte dans le Presse-papiers.

cut(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Supprime le nœud XML du document XML. Pour les nœuds d’élément, supprime l’élément entier et son contenu ; pour les nœuds d’attribut, supprime l’attribut de son élément parent.

delete(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Word.Interfaces.XmlNodeLoadOptions): Word.XmlNode;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Word.XmlNode;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.XmlNode;

Paramètres

Retours

Supprime un élément enfant de ce nœud XML. Cette méthode n’a aucun effet si le type de nœud est attribute (car les nœuds d’attribut n’ont pas d’éléments enfants).

removeChild(childElement: Word.XmlNode): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Renvoie tous les éléments enfants qui correspondent au paramètre XPath, dans l’ordre dans lequel ils apparaissent dans ce nœud XML. Renvoie null si le type de nœud est attribute (puisque les nœuds d’attribut n’ont pas d’éléments enfants à rechercher).

selectNodes(xPath: string, options?: Word.SelectNodesOptions): Word.XmlNodeCollection;

Paramètres

Retours

Collection de nœuds XML correspondant à l’expression XPath.

Remarques

Jeu d’API : WordApiDesktop 1.4

Renvoie le premier élément enfant qui correspond au paramètre XPath dans ce nœud XML. Renvoie null si le type de nœud est attribute (puisque les nœuds d’attribut n’ont pas d’éléments enfants à rechercher).

selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): Word.XmlNode;

Paramètres

Retours

Premier nœud XML qui correspond à l’expression XPath, ou null si aucune correspondance n’est trouvée.

Remarques

Jeu d’API : WordApiDesktop 1.4

Modifie le texte d’erreur de validation affiché à un utilisateur pour ce nœud XML et indique s’il faut forcer Word à signaler le nœud comme non valide. Peut ne pas être significatif pour les nœuds d’attribut.

setValidationError(status: Word.XmlValidationStatus, options?: Word.XmlNodeSetValidationErrorOptions): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Modifie le texte d’erreur de validation affiché à un utilisateur pour ce nœud XML et indique s’il faut forcer Word à signaler le nœud comme non valide. Peut ne pas être significatif pour les nœuds d’attribut.

setValidationError(status: "Ok" | "Custom", options?: Word.XmlNodeSetValidationErrorOptions): void;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.XmlNode est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.XmlNodeDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.XmlNodeData;

Retours

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet entre des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run » et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivis lors de la création initiale de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.XmlNode;

Retours

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la libération de mémoire prenne effet.

untrack(): Word.XmlNode;

Retours

Valide ce nœud XML par rapport aux schémas XML attachés au document. Peut ne pas être significatif pour les nœuds d’attribut.

validate(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.4