Word.CustomXmlNode class

Obtient un CustomXmlNodeCollection objet représentant les attributs de l’élément courant dans le nœud actuel.

readonly attributes: Word.CustomXmlNodeCollection;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Obtient le nom de base du nœud sans le préfixe d’espace de noms, s’il en existe un.

readonly baseName: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Récupère un CustomXmlNodeCollection objet contenant tous les éléments enfants du nœud en cours.

readonly childNodes: Word.CustomXmlNodeCollection;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

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 un CustomXmlNode objet correspondant au premier élément enfant du nœud en cours. Si le nœud n’a aucun élément enfant (ou s’il n’est pas de type CustomXmlNodeType.element), retourne Nothing.

readonly firstChild: Word.CustomXmlNode;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Récupère un CustomXmlNode objet correspondant au dernier élément enfant du nœud en cours. Si le nœud n’a pas d’éléments enfants (ou s’il n’est pas de type CustomXmlNodeType.element), la propriété retourne Nothing.

readonly lastChild: Word.CustomXmlNode;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Obtient l’identificateur d’adresse unique pour l’espace de noms du nœud.

readonly namespaceUri: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Renvoie le nœud frère suivant (élément, commentaire ou instruction de traitement) du nœud actif. Si le nœud est le dernier frère à son niveau, la propriété renvoie Nothing.

readonly nextSibling: Word.CustomXmlNode;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Renvoie le type du nœud actif.

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

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie la valeur du nœud actuel.

nodeValue: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Renvoie l'objet qui représente la partie associée à ce nœud.

readonly ownerPart: Word.CustomXmlPart;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Renvoie le nœud d’élément parent du nœud actif. Si le nœud actuel est au niveau racine, la propriété renvoie Nothing.

readonly parentNode: Word.CustomXmlNode;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Renvoie le nœud frère précédent (élément, commentaire ou instruction de traitement) du nœud actif. Si le nœud actuel est le premier frère à son niveau, la propriété renvoie Nothing.

readonly previousSibling: Word.CustomXmlNode;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie le texte du nœud en cours.

text: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Obtient la représentation XML du nœud actuel et de ses enfants.

readonly xml: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Obtient une chaîne avec le XPath canonique pour le nœud en cours. Si ce nœud ne figure plus dans le modèle d'objet document (DOM), cette propriété renvoie un message d'erreur.

readonly xpath: string;

Valeur de propriété

Remarques

Jeu d’API : WordApiDesktop 1.3

Ajoute un nœud unique en tant que dernier enfant sous le nœud de l'élément de contexte dans l'arborescence.

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

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Ajoute une sous-arborescence en tant que dernier enfant sous le nœud d'élément de contexte dans l'arborescence.

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

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Supprime le nœud actif de l'arborescence (y compris tous ses enfants, le cas échéant).

delete(): void;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Spécifie si le nœud d’élément actuel possède des nœuds d’élément enfants.

hasChildNodes(): OfficeExtension.ClientResult<boolean>;

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Insère un nouveau nœud juste avant le nœud de contexte dans l’arborescence.

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

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Insère la sous-arborescence spécifiée à l’emplacement juste avant le nœud de contexte.

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

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

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

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

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

Paramètres

Retours

Cette méthode supprime de l'arborescence le nœud enfant spécifié.

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

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Supprime le nœud enfant spécifié et le remplace par un autre nœud au même emplacement.

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

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Supprime le nœud spécifié et le remplace par une sous-arborescence différente au même emplacement.

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

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Sélectionne une collection de nœuds correspondant à une expression XPath.

selectNodes(xPath: string): Word.CustomXmlNodeCollection;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Sélectionne un seul nœud d'une collection correspondant à une expression XPath.

selectSingleNode(xPath: string): Word.CustomXmlNode;

Paramètres

Retours

Remarques

Jeu d’API : WordApiDesktop 1.3

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.CustomXmlNodeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.CustomXmlNode): void;

Paramètres

Retours

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.CustomXmlNode est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Word.Interfaces.CustomXmlNodeDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.CustomXmlNodeData;

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

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

Retours