Office.CustomXmlNode interface

Référence

Paquet:: office

Représente un nœud XML dans une arborescence au sein d’un document.

Remarques

Applications : Word

Propriétés

baseName	Obtient le nom de base du nœud sans le préfixe d’espace de noms, s’il en existe un.
namespaceUri	Récupère le GUID de chaîne de CustomXMLPart.
nodeType	Obtient le type de CustomXMLNode.

Méthodes

getNodesAsync(xPath, options, callback)	Obtient les nœuds associés à l’expression XPath.
getNodesAsync(xPath, callback)	Obtient les nœuds associés à l’expression XPath.
getNodeValueAsync(options, callback)	Obtient la valeur du nœud.
getNodeValueAsync(callback)	Obtient la valeur du nœud.
getTextAsync(options, callback)	Obtient le texte d’un nœud XML dans une partie XML personnalisée.
getTextAsync(callback)	Obtient le texte d’un nœud XML dans une partie XML personnalisée.
getXmlAsync(options, callback)	Obtient le code XML du nœud.
getXmlAsync(callback)	Obtient le code XML du nœud.
setNodeValueAsync(value, options, callback)	Définit la valeur du nœud.
setNodeValueAsync(value, callback)	Définit la valeur du nœud.
setTextAsync(text, options, callback)	Définit de manière asynchrone le texte d’un nœud XML dans une partie XML personnalisée.
setTextAsync(text, callback)	Définit de manière asynchrone le texte d’un nœud XML dans une partie XML personnalisée.
setXmlAsync(xml, options, callback)	Définit le code XML du nœud.
setXmlAsync(xml, callback)	Définit le code XML du nœud.

Détails de la propriété

baseName

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

baseName: string;

Valeur de propriété

string

Exemples

function showXmlNodeBaseNames() {
    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.baseName);
            }
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

namespaceUri

Récupère le GUID de chaîne de CustomXMLPart.

namespaceUri: string;

Valeur de propriété

string

Exemples

function showXmlNamespaceUri() {
    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.namespaceUri);
            }
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

nodeType

Obtient le type de CustomXMLNode.

nodeType: string;

Valeur de propriété

string

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; 
}

Détails de la méthode

getNodesAsync(xPath, options, callback)

Obtient les nœuds associés à l’expression XPath.

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

Paramètres

xPath: string

Expression XPath qui spécifie les nœuds à obtenir. 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 xPath paramètre .

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

getNodesAsync(xPath, callback)

Obtient les nœuds associés à l’expression XPath.

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

Paramètres

xPath: string

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

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

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

Exemples

function showXmlChildNodes() {
    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];
                node.getNodesAsync('*', function (nodeResults) {
                    write(nodeResults.value.length + " childNodes");
                });
            }
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

getNodeValueAsync(options, callback)

Obtient la valeur du nœud.

getNodeValueAsync(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 la valeur du nœud référencé.

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

getNodeValueAsync(callback)

Obtient la valeur du nœud.

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

Paramètres

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

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

Exemples

function showXmlNodeValues() {
    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];
                node.getNodeValueAsync(function (asyncResult) {
                    write(asyncResult.value);
                });
            }
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

getTextAsync(options, callback)

Obtient le texte d’un nœud XML dans une partie XML personnalisée.

getTextAsync(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

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

Exemples

// Get the built-in core properties XML part by using its ID. This results in a call to Word.
Office.context.document.customXmlParts.getByIdAsync(
    "{6C3C8BC8-F283-45AE-878A-BAB7291924A1}", function (getByIdAsyncResult) {
    
    // Access the XML part.
    const xmlPart = getByIdAsyncResult.value;
    
    // Add namespaces to the namespace manager. These two calls result in two calls to Word.
    xmlPart.namespaceManager.addNamespaceAsync(
        'cp',
        'http://schemas.openxmlformats.org/package/2006/metadata/core-properties',
        function () {
        xmlPart.namespaceManager.addNamespaceAsync(
            'dc', 
            'http://purl.org/dc/elements/1.1/', 
            function () {

            // Get XML nodes by using an Xpath expression. This results in a call to Word.
            xmlPart.getNodesAsync("/cp:coreProperties/dc:title", function (getNodesAsyncResult) {
                
                // Get the first node returned by using the Xpath expression. 
                const node = getNodesAsyncResult.value[0];
                
                // Get the text value of the node and use the asyncContext. This results in a call to Word. 
                // The results are logged to the browser console.
                node.getTextAsync({asyncContext: "StateNormal"}, function (getTextAsyncResult) {
                  console.log("Text of the title element = " + getTextAsyncResult.value;
                  console.log("The asyncContext value = " + getTextAsyncResult.asyncContext;
                });
            });
        });
    });
});

getTextAsync(callback)

Obtient le texte d’un nœud XML dans une partie XML personnalisée.

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

Paramètres

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

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

getXmlAsync(options, callback)

Obtient le code XML du nœud.

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

Retours

void

Remarques

Ensemble de conditions requises : CustomXmlParts

getXmlAsync(callback)

Obtient le code XML du nœud.

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 showXmlNodeInnerXml() {
    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];
                node.getXmlAsync(function (asyncResult) {
                    write(asyncResult.value);
                });
            }
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

setNodeValueAsync(value, options, callback)

Définit la valeur du nœud.

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

Paramètres

value: string

Valeur à définir sur le nœud

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

setNodeValueAsync(value, callback)

Définit la valeur du nœud.

setNodeValueAsync(value: string, callback?: (result: AsyncResult<void>) => void): void;

Paramètres

value: string

Valeur à définir sur le nœud

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 setXmlNodeValue() {
    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);
                node.setNodeValueAsync("item number" + i, function (result) { });
            }
        });
    });
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

setTextAsync(text, options, callback)

Définit de manière asynchrone le texte d’un nœud XML dans une partie XML personnalisée.

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

Paramètres

text: string

Obligatoire. Valeur de texte du nœud XML.

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

Exemples

// Learn how to set the text value of a node in a custom XML part from the following example.

// Get the built-in core properties XML part by using its ID. This results in a call to Word.
Office.context.document.customXmlParts.getByIdAsync(
    "{6C3C8BC8-F283-45AE-878A-BAB7291924A1}",
    function (getByIdAsyncResult) {
    
    // Access the XML part.
    const xmlPart = getByIdAsyncResult.value;
    
    // Add namespaces to the namespace manager. These two calls result in two calls to Word.
    xmlPart.namespaceManager.addNamespaceAsync(
        'cp', 
        'http://schemas.openxmlformats.org/package/2006/metadata/core-properties', 
        function () {
        xmlPart.namespaceManager.addNamespaceAsync(
            'dc', 
            'http://purl.org/dc/elements/1.1/', 
            function () {

            // Get XML nodes by using an Xpath expression. This results in a call to the host.
            xmlPart.getNodesAsync("/cp:coreProperties/dc:subject", function (getNodesAsyncResult) {
                
                // Get the first node returned by using the Xpath expression.
                // This will be the subject element in this example.
                const subjectNode = getNodesAsyncResult.value[0];
                
                // Set the text value of the subject node and use the asyncContext. 
                // This results in a call to the host.  The results are logged to the browser console.
                subjectNode.setTextAsync(
                    "newSubject", 
                    {asyncContext: "StateNormal"}, 
                    function (setTextAsyncResult) {
                        console.log("The status of the call: " + setTextAsyncResult.status);
                        console.log("The asyncContext value = " + setTextAsyncResult.asyncContext);
                });
            });
        });
    });
});

setTextAsync(text, callback)

Définit de manière asynchrone le texte d’un nœud XML dans une partie XML personnalisée.

setTextAsync(text: string, callback?: (result: AsyncResult<void>) => void): void;

Paramètres

text: string

Obligatoire. Valeur de texte du nœud XML.

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

setXmlAsync(xml, options, callback)

Définit le code XML du nœud.

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

Paramètres

xml: string

Xml à définir sur le nœud

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

Exemples

function setXmlNodeInnerXml() {
    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];
                node.setXmlAsync("<childNode>" + i + "</childNode>");
            }
        });
    });
}

setXmlAsync(xml, callback)

Définit le code XML du nœud.

setXmlAsync(xml: string, callback?: (result: AsyncResult<void>) => void): void;

Paramètres

xml: string

Xml à définir sur le nœud

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

Partager via

Office.CustomXmlNode interface

Remarques

Propriétés

Méthodes

Détails de la propriété

baseName

Valeur de propriété

Exemples

namespaceUri

Valeur de propriété

Exemples

nodeType

Valeur de propriété

Exemples

Détails de la méthode

getNodesAsync(xPath, options, callback)

Paramètres

Retours

Remarques

getNodesAsync(xPath, callback)

Paramètres

Retours

Remarques

Exemples

getNodeValueAsync(options, callback)

Paramètres

Retours

Remarques

getNodeValueAsync(callback)

Paramètres

Retours

Remarques

Exemples

getTextAsync(options, callback)

Paramètres

Retours

Remarques

Exemples

getTextAsync(callback)

Paramètres

Retours

Remarques

getXmlAsync(options, callback)

Paramètres

Retours

Remarques

getXmlAsync(callback)

Paramètres

Retours

Remarques

Exemples

setNodeValueAsync(value, options, callback)

Paramètres

Retours

Remarques

setNodeValueAsync(value, callback)

Paramètres

Retours

Remarques

Exemples

setTextAsync(text, options, callback)

Paramètres

Retours

Remarques

Exemples

setTextAsync(text, callback)

Paramètres

Retours

Remarques

setXmlAsync(xml, options, callback)

Paramètres

Retours

Remarques

Exemples

setXmlAsync(xml, callback)

Paramètres

Retours

Remarques

Ressources supplémentaires