Word.XmlMapping class

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Renvoie un CustomXmlNode objet qui représente le nœud XML personnalisé dans le magasin de données auquel le contrôle de contenu du document est mappé.

readonly customXmlNode: Word.CustomXmlNode;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Renvoie un CustomXmlPart objet qui représente la partie XML personnalisée à laquelle le contrôle de contenu dans le document est mappé.

readonly customXmlPart: Word.CustomXmlPart;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Renvoie une valeur indiquant si le contrôle de contenu du document est mappé à un nœud XML dans le magasin de données XML du document.

readonly isMapped: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Retourne les mappages de préfixe utilisés pour évaluer le XPath pour le mappage XML actuel.

readonly prefixMappings: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Retourne le XPath pour le mappage XML, qui prend la valeur du nœud XML actuellement mappé.

readonly xpath: string;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Supprime le mappage XML du contrôle de contenu parent.

delete(): void;

Retours

Remarques

[ Ensemble 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.XmlMappingLoadOptions): Word.XmlMapping;

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

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

Paramètres

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.XmlMappingUpdateData, 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.XmlMapping): void;

Paramètres

Retours

Permet de créer ou de modifier le mappage XML sur le contrôle de contenu.

setMapping(xPath: string, options?: Word.XmlSetMappingOptions): OfficeExtension.ClientResult<boolean>;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Permet de créer ou de modifier le mappage de données XML sur le contrôle de contenu.

setMappingByNode(node: Word.CustomXmlNode): OfficeExtension.ClientResult<boolean>;

Paramètres

Retours

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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.XmlMapping est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.XmlMappingDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.XmlMappingData;

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 sur 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 suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.XmlMapping;

Retours

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour 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 mise en production de la mémoire ne prenne effet.

untrack(): Word.XmlMapping;

Retours