Office.CustomXmlNode interface

Referência

Pacote:: office

Representa um nó XML em uma árvore em um documento.

Comentários

Aplicações: Word

Propriedades

baseName	Obtém o nome de base do nó sem o prefixo do namespace, caso exista um.
namespaceUri	Recupera o GUID da cadeia de caracteres do CustomXMLPart.
nodeType	Obtém o tipo do CustomXMLNode.

Métodos

getNodesAsync(xPath, options, callback)	Obtém os nós associados à expressão XPath.
getNodesAsync(xPath, callback)	Obtém os nós associados à expressão XPath.
getNodeValueAsync(options, callback)	Obtém o valor do nó.
getNodeValueAsync(callback)	Obtém o valor do nó.
getTextAsync(options, callback)	Obtém o texto de um nó XML numa peça XML personalizada.
getTextAsync(callback)	Obtém o texto de um nó XML numa peça XML personalizada.
getXmlAsync(options, callback)	Obtém o XML do nó.
getXmlAsync(callback)	Obtém o XML do nó.
setNodeValueAsync(value, options, callback)	Define o valor do nó.
setNodeValueAsync(value, callback)	Define o valor do nó.
setTextAsync(text, options, callback)	Define de forma assíncrona o texto de um nó XML em uma parte XML personalizada.
setTextAsync(text, callback)	Define de forma assíncrona o texto de um nó XML em uma parte XML personalizada.
setXmlAsync(xml, options, callback)	Define o XML do nó.
setXmlAsync(xml, callback)	Define o XML do nó.

Detalhes da propriedade

baseName

Obtém o nome de base do nó sem o prefixo do namespace, caso exista um.

baseName: string;

Valor da propriedade

string

Exemplos

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

Recupera o GUID da cadeia de caracteres do CustomXMLPart.

namespaceUri: string;

Valor da propriedade

string

Exemplos

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

Obtém o tipo do CustomXMLNode.

nodeType: string;

Valor da propriedade

string

Exemplos

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

Detalhes do método

getNodesAsync(xPath, options, callback)

Obtém os nós associados à expressão XPath.

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

Parâmetros

xPath: string

A expressão XPath que especifica os nós a obter. Obrigatório.

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para utilização numa chamada de retorno.

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

Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é uma matriz de objetos CustomXmlNode que representam os nós especificados pela expressão XPath transmitida para o xPath parâmetro .

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

getNodesAsync(xPath, callback)

Obtém os nós associados à expressão XPath.

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

Parâmetros

xPath: string

A expressão XPath que especifica os nós a obter. Obrigatório.

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

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Exemplos

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)

Obtém o valor do nó.

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

Parâmetros

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para utilização numa chamada de retorno.

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

Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é uma cadeia que contém o valor do nó referenciado.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

getNodeValueAsync(callback)

Obtém o valor do nó.

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

Parâmetros

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

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Exemplos

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)

Obtém o texto de um nó XML numa peça XML personalizada.

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

Parâmetros

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para utilização numa chamada de retorno.

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

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Exemplos

// 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)

Obtém o texto de um nó XML numa peça XML personalizada.

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

Parâmetros

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

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

getXmlAsync(options, callback)

Obtém o XML do nó.

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

Parâmetros

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para utilização numa chamada de retorno.

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

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

getXmlAsync(callback)

Obtém o XML do nó.

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

Parâmetros

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

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Exemplos

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)

Define o valor do nó.

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

Parâmetros

value: string

O valor a ser definido no nó

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para utilização numa chamada de retorno.

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

Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

setNodeValueAsync(value, callback)

Define o valor do nó.

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

Parâmetros

value: string

O valor a ser definido no nó

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

Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Exemplos

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)

Define de forma assíncrona o texto de um nó XML em uma parte XML personalizada.

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

Parâmetros

text: string

Obrigatório. O valor do texto do nó XML.

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para utilização numa chamada de retorno.

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

Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Exemplos

// 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)

Define de forma assíncrona o texto de um nó XML em uma parte XML personalizada.

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

Parâmetros

text: string

Obrigatório. O valor do texto do nó XML.

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

Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

setXmlAsync(xml, options, callback)

Define o XML do nó.

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

Parâmetros

xml: string

O XML a ser definido no nó

options: Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para utilização numa chamada de retorno.

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

Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Exemplos

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)

Define o XML do nó.

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

Parâmetros

xml: string

O XML a ser definido no nó

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

Opcional. Uma função que é invocada quando a chamada de retorno é devolvida, cujo único parâmetro é do tipo Office.AsyncResult.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Compartilhar via

Office.CustomXmlNode interface

Comentários

Propriedades

Métodos

Detalhes da propriedade

baseName

Valor da propriedade

Exemplos

namespaceUri

Valor da propriedade

Exemplos

nodeType

Valor da propriedade

Exemplos

Detalhes do método

getNodesAsync(xPath, options, callback)

Parâmetros

Retornos

Comentários

getNodesAsync(xPath, callback)

Parâmetros

Retornos

Comentários

Exemplos

getNodeValueAsync(options, callback)

Parâmetros

Retornos

Comentários

getNodeValueAsync(callback)

Parâmetros

Retornos

Comentários

Exemplos

getTextAsync(options, callback)

Parâmetros

Retornos

Comentários

Exemplos

getTextAsync(callback)

Parâmetros

Retornos

Comentários

getXmlAsync(options, callback)

Parâmetros

Retornos

Comentários

getXmlAsync(callback)

Parâmetros

Retornos

Comentários

Exemplos

setNodeValueAsync(value, options, callback)

Parâmetros

Retornos

Comentários

setNodeValueAsync(value, callback)

Parâmetros

Retornos

Comentários

Exemplos

setTextAsync(text, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

setTextAsync(text, callback)

Parâmetros

Retornos

Comentários

setXmlAsync(xml, options, callback)

Parâmetros

Retornos

Comentários

Exemplos

setXmlAsync(xml, callback)

Parâmetros

Retornos

Comentários

Recursos adicionais