Office.CustomXmlPart interface

Référence

Paquet:: office

Représente un seul CustomXMLPart dans une collection Office.CustomXmlParts .

Remarques

Applications : Word

Propriétés

builtIn	True, si la partie XML personnalisée est intégrée ; sinon, false.
id	Obtient le GUID de CustomXMLPart.
namespaceManager	Obtient l’ensemble des mappages de préfixes d’espace de noms (Office.CustomXmlPrefixMappings) utilisés sur le CustomXmlPart actuel.

Méthodes

addHandlerAsync(eventType, handler, options, callback)	Ajoute un gestionnaire d’événements à l’objet à l’aide du type d’événement spécifié.
addHandlerAsync(eventType, handler, callback)	Ajoute un gestionnaire d’événements à l’objet à l’aide du type d’événement spécifié.
deleteAsync(options, callback)	Supprime le composant XML personnalisé.
deleteAsync(callback)	Supprime le composant XML personnalisé.
getNodesAsync(xPath, options, callback)	Obtient de manière asynchrone les CustomXmlNodes de cette partie XML personnalisée qui correspondent au XPath spécifié.
getNodesAsync(xPath, callback)	Obtient de manière asynchrone les CustomXmlNodes de cette partie XML personnalisée qui correspondent au XPath spécifié.
getXmlAsync(options, callback)	Obtient de manière asynchrone le code XML contenu dans cette partie XML personnalisée.
getXmlAsync(callback)	Obtient de manière asynchrone le code XML contenu dans cette partie XML personnalisée.
removeHandlerAsync(eventType, handler, options, callback)	Supprime un gestionnaire d’événements pour le type d’événement spécifié.
removeHandlerAsync(eventType, handler, callback)	Supprime un gestionnaire d’événements pour le type d’événement spécifié.

Détails de la propriété

builtIn

True, si la partie XML personnalisée est intégrée ; sinon, false.

builtIn: boolean;

Valeur de propriété

boolean

Exemples

function showXMLPartBuiltIn() {
    Office.context.document.customXmlParts.getByIdAsync(
        "{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        const xmlPart = result.value;
        write(xmlPart.builtIn);
    });
}

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

id

Obtient le GUID de CustomXMLPart.

id: string;

Valeur de propriété

string

Exemples

function showXMLPartBuiltId() {
    Office.context.document.customXmlParts.getByIdAsync(
        "{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        const xmlPart = result.value;
        write(xmlPart.id);
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

namespaceManager

Obtient l’ensemble des mappages de préfixes d’espace de noms (Office.CustomXmlPrefixMappings) utilisés sur le CustomXmlPart actuel.

namespaceManager: CustomXmlPrefixMappings;

Valeur de propriété

Office.CustomXmlPrefixMappings

Exemples

function setXMLPartNamespaceManagerNamespace() {
    Office.context.document.customXmlParts.getByIdAsync(
        "{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        const xmlPart = result.value;
        xmlPart.namespaceManager.addNamespaceAsync("myPrefix", "myNamespace");
    });
}

Détails de la méthode

addHandlerAsync(eventType, handler, options, callback)

Ajoute un gestionnaire d’événements à l’objet à l’aide du type d’événement spécifié.

addHandlerAsync(eventType: Office.EventType, handler: (result: any) => void, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Paramètres

eventType: Office.EventType

Spécifie le type d’événement à ajouter. Pour un objet CustomXmlPart, le paramètre eventType peut être spécifié en tant que Office.EventType.NodeDeleted, Office.EventType.NodeInsertedet Office.EventType.NodeReplaced.

handler: (result: any) => void

Fonction de gestionnaire d’événements à ajouter, dont le seul paramètre est de type Office.NodeDeletedEventArgs, Office.NodeInsertedEventArgs ou Office.NodeReplacedEventArgs

options: Office.AsyncContextOptions

Fournit une option permettant de conserver les données de contexte de tout type, inchangées, pour une utilisation dans un rappel.

callback: (result: Office.AsyncResult<void>) => void

Optional. Fonction appelée lorsque le rappel est retourné, dont le seul paramètre est de type Office.AsyncResult.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

Vous pouvez ajouter plusieurs gestionnaires d’événements pour le eventType spécifié tant que le nom de chaque fonction de gestionnaire d’événements est unique.

addHandlerAsync(eventType, handler, callback)

Ajoute un gestionnaire d’événements à l’objet à l’aide du type d’événement spécifié.

addHandlerAsync(eventType: Office.EventType, handler: (result: any) => void, callback?: (result: AsyncResult<void>) => void): void;

Paramètres

eventType: Office.EventType

handler: (result: any) => void

Fonction de gestionnaire d’événements à ajouter, dont le seul paramètre est de type Office.NodeDeletedEventArgs, Office.NodeInsertedEventArgs ou Office.NodeReplacedEventArgs

callback: (result: Office.AsyncResult<void>) => void

Optional. Fonction appelée lorsque le rappel est retourné, dont le seul paramètre est de type Office.AsyncResult.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

Vous pouvez ajouter plusieurs gestionnaires d’événements pour le eventType spécifié tant que le nom de chaque fonction de gestionnaire d’événements est unique.

Exemples

// To add an event handler for the NodeDeleted event, use the addHandlerAsync method of the CustomXmlPart object.
function addNodeDeletedEvent() {
    Office.context.document.customXmlParts.getByIdAsync(
        "{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        const xmlPart = result.value;
        xmlPart.addHandlerAsync(Office.EventType.NodeDeleted, function (eventArgs) {
            write("A node has been deleted.");
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message;
}

// To add an event handler for the NodeInserted event, use the addHandlerAsync method of the CustomXmlPart object.
function addNodeInsertedEvent() {
    Office.context.document.customXmlParts.getByIdAsync(
        "{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        const xmlPart = result.value;
        xmlPart.addHandlerAsync(Office.EventType.NodeInserted, function (eventArgs) {
            write("A node has been inserted.");
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message;
}

// To add an event handler for the NodeReplaced event, use the addHandlerAsync method of the CustomXmlPart object.
function addNodeReplacedEvent() {
    Office.context.document.customXmlParts.getByIdAsync(
        "{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        const xmlPart = result.value;
        xmlPart.addHandlerAsync(Office.EventType.NodeReplaced, function (eventArgs) {
            write("A node has been replaced.");
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message;
}

deleteAsync(options, callback)

Supprime le composant XML personnalisé.

deleteAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Paramètres

options: Office.AsyncContextOptions

Fournit une option permettant de conserver les données de contexte de tout type, inchangées, pour une utilisation dans un rappel.

callback: (result: Office.AsyncResult<void>) => void

Optional. Fonction appelée lorsque le rappel est retourné, dont le seul paramètre est de type Office.AsyncResult.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

deleteAsync(callback)

Supprime le composant XML personnalisé.

deleteAsync(callback?: (result: AsyncResult<void>) => void): void;

Paramètres

callback: (result: Office.AsyncResult<void>) => void

Optional. Fonction appelée lorsque le rappel est retourné, dont le seul paramètre est de type Office.AsyncResult.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

Exemples

function deleteXMLPart() {
    Office.context.document.customXmlParts.getByIdAsync(
        "{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        const xmlPart = result.value;
        xmlPart.deleteAsync(function (eventArgs) {
            write("The XML Part has been deleted.");
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

getNodesAsync(xPath, options, callback)

Obtient de manière asynchrone les CustomXmlNodes de cette partie XML personnalisée qui correspondent au XPath spécifié.

getNodesAsync(xPath: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<CustomXmlNode[]>) => void): void;

Paramètres

xPath: string

Expression XPath qui spécifie les nœuds à retourner. Obligatoire.

options: Office.AsyncContextOptions

Fournit une option permettant de conserver les données de contexte de tout type, inchangées, pour une utilisation dans un rappel.

callback: (result: Office.AsyncResult<Office.CustomXmlNode[]>) => void

Optional. Fonction appelée lorsque le rappel est retourné, dont le seul paramètre est de type Office.AsyncResult. La value propriété du résultat est un tableau d’objets CustomXmlNode qui représentent les nœuds spécifiés par l’expression XPath passée au paramètre xPath.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

getNodesAsync(xPath, callback)

Obtient de manière asynchrone les CustomXmlNodes de cette partie XML personnalisée qui correspondent au XPath spécifié.

getNodesAsync(xPath: string, callback?: (result: AsyncResult<CustomXmlNode[]>) => void): void;

Paramètres

xPath: string

Expression XPath qui spécifie les nœuds à retourner. Obligatoire.

callback: (result: Office.AsyncResult<Office.CustomXmlNode[]>) => void

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

Exemples

function showXmlNodeType() {
    Office.context.document.customXmlParts.getByIdAsync(
        "{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        const xmlPart = result.value;
        xmlPart.getNodesAsync('*/*', function (nodeResults) {
            for (let i = 0; i < nodeResults.value.length; i++) {
                const node = nodeResults.value[i];
                write(node.nodeType);
            }
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

getXmlAsync(options, callback)

Obtient de manière asynchrone le code XML contenu dans cette partie XML personnalisée.

getXmlAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;

Paramètres

options: Office.AsyncContextOptions

Fournit une option permettant de conserver les données de contexte de tout type, inchangées, pour une utilisation dans un rappel.

callback: (result: Office.AsyncResult<string>) => void

Optional. Fonction appelée lorsque le rappel est retourné, dont le seul paramètre est de type Office.AsyncResult. La value propriété du résultat est une chaîne qui contient le CODE XML de l’objet CustomXmlPart référencé.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

getXmlAsync(callback)

Obtient de manière asynchrone le code XML contenu dans cette partie XML personnalisée.

getXmlAsync(callback?: (result: AsyncResult<string>) => void): void;

Paramètres

callback: (result: Office.AsyncResult<string>) => void

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

Exemples

function showXMLPartInnerXML() {
    Office.context.document.customXmlParts.getByIdAsync(
        "{3BC85265-09D6-4205-B665-8EB239A8B9A1}", function (result) {
        const xmlPart = result.value;
        xmlPart.getXmlAsync(function (eventArgs) {
            write(eventArgs.value);
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

removeHandlerAsync(eventType, handler, options, callback)

Supprime un gestionnaire d’événements pour le type d’événement spécifié.

removeHandlerAsync(eventType: Office.EventType, handler?: (result: any) => void, options?: RemoveHandlerOptions, callback?: (result: AsyncResult<void>) => void): void;

Paramètres

eventType: Office.EventType

Spécifie le type d’événement à supprimer. Pour un objet CustomXmlPart, le paramètre eventType peut être spécifié en tant que Office.EventType.NodeDeleted, Office.EventType.NodeInsertedet Office.EventType.NodeReplaced.

handler: (result: any) => void

Nom du gestionnaire à supprimer.

options: Office.RemoveHandlerOptions

Fournit des options pour déterminer le ou les gestionnaires d’événements qui sont supprimés.

callback: (result: Office.AsyncResult<void>) => void

Optional. Fonction appelée lorsque le rappel est retourné, dont le seul paramètre est de type Office.AsyncResult.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

removeHandlerAsync(eventType, handler, callback)

Supprime un gestionnaire d’événements pour le type d’événement spécifié.

removeHandlerAsync(eventType: Office.EventType, handler?: (result: any) => void, callback?: (result: AsyncResult<void>) => void): void;

Paramètres

eventType: Office.EventType

handler: (result: any) => void

Nom du gestionnaire à supprimer.

callback: (result: Office.AsyncResult<void>) => void

Optional. Fonction appelée lorsque le rappel est retourné, dont le seul paramètre est de type Office.AsyncResult.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

Exemples

function removeNodeInsertedEventHandler() {
    Office.context.document.customXmlParts.getByIdAsync(
        "{3BC85265-09D6-4205-B665-8EB239A8B9A1}",
        function (result) {
            const xmlPart = result.value;
            xmlPart.removeHandlerAsync(Office.EventType.DataNodeInserted, {handler:myHandler});
    });
}

Partager via

Office.CustomXmlPart interface

Remarques

Propriétés

Méthodes

Détails de la propriété

builtIn

Valeur de propriété

Exemples

id

Valeur de propriété

Exemples

namespaceManager

Valeur de propriété

Exemples

Détails de la méthode

addHandlerAsync(eventType, handler, options, callback)

Paramètres

Retours

Remarques

addHandlerAsync(eventType, handler, callback)

Paramètres

Retours

Remarques

Exemples

deleteAsync(options, callback)

Paramètres

Retours

Remarques

deleteAsync(callback)

Paramètres

Retours

Remarques

Exemples

getNodesAsync(xPath, options, callback)

Paramètres

Retours

Remarques

getNodesAsync(xPath, callback)

Paramètres

Retours

Remarques

Exemples

getXmlAsync(options, callback)

Paramètres

Retours

Remarques

getXmlAsync(callback)

Paramètres

Retours

Remarques

Exemples

removeHandlerAsync(eventType, handler, options, callback)

Paramètres

Retours

Remarques

removeHandlerAsync(eventType, handler, callback)

Paramètres

Retours

Remarques

Exemples

Ressources supplémentaires