Office.CustomXmlNode interface

Referencia

Paquete:: office

Representa un nodo XML en un árbol de un documento.

Comentarios

Aplicaciones: Word

Propiedades

baseName	Obtiene el nombre base del nodo sin el prefijo de espacio de nombres, si existe alguno.
namespaceUri	Recupera el GUID de cadena del elemento CustomXMLPart.
nodeType	Obtiene el tipo de CustomXMLNode.

Métodos

getNodesAsync(xPath, options, callback)	Obtiene los nodos asociados a la expresión XPath.
getNodesAsync(xPath, callback)	Obtiene los nodos asociados a la expresión XPath.
getNodeValueAsync(options, callback)	Obtiene el valor del nodo.
getNodeValueAsync(callback)	Obtiene el valor del nodo.
getTextAsync(options, callback)	Obtiene el texto de un nodo XML en un elemento XML personalizado.
getTextAsync(callback)	Obtiene el texto de un nodo XML en un elemento XML personalizado.
getXmlAsync(options, callback)	Obtiene el XML del nodo.
getXmlAsync(callback)	Obtiene el XML del nodo.
setNodeValueAsync(value, options, callback)	Establece el valor del nodo.
setNodeValueAsync(value, callback)	Establece el valor del nodo.
setTextAsync(text, options, callback)	Obtiene el texto de un nodo XML de forma asíncrona en un elemento XML personalizado.
setTextAsync(text, callback)	Obtiene el texto de un nodo XML de forma asíncrona en un elemento XML personalizado.
setXmlAsync(xml, options, callback)	Establece el XML del nodo.
setXmlAsync(xml, callback)	Establece el XML del nodo.

Detalles de las propiedades

baseName

Obtiene el nombre base del nodo sin el prefijo de espacio de nombres, si existe alguno.

baseName: string;

Valor de propiedad

string

Ejemplos

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 el GUID de cadena del elemento CustomXMLPart.

namespaceUri: string;

Valor de propiedad

string

Ejemplos

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

Obtiene el tipo de CustomXMLNode.

nodeType: string;

Valor de propiedad

string

Ejemplos

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

Detalles del método

getNodesAsync(xPath, options, callback)

Obtiene los nodos asociados a la expresión XPath.

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

Parámetros

xPath: string

Expresión XPath que especifica los nodos que se van a obtener. Obligatorio.

options: Office.AsyncContextOptions

Proporciona una opción para conservar los datos de contexto de cualquier tipo, sin cambios, para su uso en una devolución de llamada.

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult. La value propiedad del resultado es una matriz de objetos CustomXmlNode que representan los nodos especificados por la expresión XPath pasada al xPath parámetro .

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

getNodesAsync(xPath, callback)

Obtiene los nodos asociados a la expresión XPath.

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

Parámetros

xPath: string

Expresión XPath que especifica los nodos que se van a obtener. Obligatorio.

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

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

Ejemplos

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)

Obtiene el valor del nodo.

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

Parámetros

options: Office.AsyncContextOptions

Proporciona una opción para conservar los datos de contexto de cualquier tipo, sin cambios, para su uso en una devolución de llamada.

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult. La value propiedad del resultado es una cadena que contiene el valor del nodo al que se hace referencia.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

getNodeValueAsync(callback)

Obtiene el valor del nodo.

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

Parámetros

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

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

Ejemplos

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)

Obtiene el texto de un nodo XML en un elemento XML personalizado.

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

Parámetros

options: Office.AsyncContextOptions

Proporciona una opción para conservar los datos de contexto de cualquier tipo, sin cambios, para su uso en una devolución de llamada.

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

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

Ejemplos

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

Obtiene el texto de un nodo XML en un elemento XML personalizado.

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

Parámetros

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

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

getXmlAsync(options, callback)

Obtiene el XML del nodo.

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

Parámetros

options: Office.AsyncContextOptions

Proporciona una opción para conservar los datos de contexto de cualquier tipo, sin cambios, para su uso en una devolución de llamada.

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

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

getXmlAsync(callback)

Obtiene el XML del nodo.

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

Parámetros

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

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

Ejemplos

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)

Establece el valor del nodo.

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

Parámetros

value: string

Valor que se va a establecer en el nodo

options: Office.AsyncContextOptions

Proporciona una opción para conservar los datos de contexto de cualquier tipo, sin cambios, para su uso en una devolución de llamada.

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

setNodeValueAsync(value, callback)

Establece el valor del nodo.

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

Parámetros

value: string

Valor que se va a establecer en el nodo

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

Ejemplos

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)

Obtiene el texto de un nodo XML de forma asíncrona en un elemento XML personalizado.

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

Parámetros

text: string

Obligatorio. El valor de texto del nodo XML.

options: Office.AsyncContextOptions

Proporciona una opción para conservar los datos de contexto de cualquier tipo, sin cambios, para su uso en una devolución de llamada.

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

Ejemplos

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

Obtiene el texto de un nodo XML de forma asíncrona en un elemento XML personalizado.

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

Parámetros

text: string

Obligatorio. El valor de texto del nodo XML.

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

setXmlAsync(xml, options, callback)

Establece el XML del nodo.

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

Parámetros

xml: string

Xml que se va a establecer en el nodo

options: Office.AsyncContextOptions

Proporciona una opción para conservar los datos de contexto de cualquier tipo, sin cambios, para su uso en una devolución de llamada.

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

Ejemplos

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)

Establece el XML del nodo.

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

Parámetros

xml: string

Xml que se va a establecer en el nodo

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

Opcional. Función que se invoca cuando se devuelve la devolución de llamada, cuyo único parámetro es de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

Compartir a través de

Office.CustomXmlNode interface

Comentarios

Propiedades

Métodos

Detalles de las propiedades

baseName

Valor de propiedad

Ejemplos

namespaceUri

Valor de propiedad

Ejemplos

nodeType

Valor de propiedad

Ejemplos

Detalles del método

getNodesAsync(xPath, options, callback)

Parámetros

Devoluciones

Comentarios

getNodesAsync(xPath, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

getNodeValueAsync(options, callback)

Parámetros

Devoluciones

Comentarios

getNodeValueAsync(callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

getTextAsync(options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

getTextAsync(callback)

Parámetros

Devoluciones

Comentarios

getXmlAsync(options, callback)

Parámetros

Devoluciones

Comentarios

getXmlAsync(callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

setNodeValueAsync(value, options, callback)

Parámetros

Devoluciones

Comentarios

setNodeValueAsync(value, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

setTextAsync(text, options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

setTextAsync(text, callback)

Parámetros

Devoluciones

Comentarios

setXmlAsync(xml, options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

setXmlAsync(xml, callback)

Parámetros

Devoluciones

Comentarios

Recursos adicionales