Office.CustomXmlParts interface

  • Referencia
Paquete:
office

Representa una colección de objetos CustomXmlPart.

Comentarios

Aplicaciones: Word

Métodos

addAsync(xml, options, callback)

Agrega de forma asíncrona un nuevo elemento XML personalizado a un archivo.
addAsync(xml, callback)

Agrega de forma asíncrona un nuevo elemento XML personalizado a un archivo.
getByIdAsync(id, options, callback)

Obtiene de forma asincrónica el elemento XML personalizado especificado por su identificador.
getByIdAsync(id, callback)

Obtiene de forma asincrónica el elemento XML personalizado especificado por su identificador.
getByNamespaceAsync(ns, options, callback)

Obtiene de forma asincrónica los elementos XML personalizados especificados por su espacio de nombres.
getByNamespaceAsync(ns, callback)

Obtiene de forma asincrónica los elementos XML personalizados especificados por su espacio de nombres.

Detalles del método

addAsync(xml, options, callback)

Agrega de forma asíncrona un nuevo elemento XML personalizado a un archivo.

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

Parámetros

xml

string

El contenido XML que se desea agregar al elemento XML personalizado que se acaba de crear.

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.CustomXmlPart>) => 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 el objeto CustomXmlPart recién creado.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

addAsync(xml, callback)

Agrega de forma asíncrona un nuevo elemento XML personalizado a un archivo.

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

Parámetros

xml

string

El contenido XML que se desea agregar al elemento XML personalizado que se acaba de crear.

callback

(result: Office.AsyncResult<Office.CustomXmlPart>) => 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 el objeto CustomXmlPart recién creado.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

Ejemplos

function addXMLPart() {
    Office.context.document.customXmlParts.addAsync(
        '<root categoryId="1" xmlns="http://tempuri.org"><item name="Cheap Item" price="$193.95"/><item name="Expensive Item" price="$931.88"/></root>',
        function (result) {});
}

function addXMLPartandHandler() {
    Office.context.document.customXmlParts.addAsync(
        "<testns:book xmlns:testns='http://testns.com'><testns:page number='1'>Hello</testns:page><testns:page number='2'>world!</testns:page></testns:book>",
        function(r) { r.value.addHandlerAsync(Office.EventType.DataNodeDeleted,
            function(a) {write(a.type)
            },
                function(s) {write(s.status)
                });
        });
}

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

getByIdAsync(id, options, callback)

Obtiene de forma asincrónica el elemento XML personalizado especificado por su identificador.

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

Parámetros

id

string

El GUID del elemento XML personalizado, incluidas las llaves de apertura y cierre.

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.CustomXmlPart>) => 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 un objeto CustomXmlPart que representa el elemento XML personalizado especificado. Si no hay ningún elemento XML personalizado con el identificador especificado, el método devuelve null.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

Ejemplos

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

getByIdAsync(id, callback)

Obtiene de forma asincrónica el elemento XML personalizado especificado por su identificador.

getByIdAsync(id: string, callback?: (result: AsyncResult<CustomXmlPart>) => void): void;

Parámetros

id

string

El GUID del elemento XML personalizado, incluidas las llaves de apertura y cierre.

callback

(result: Office.AsyncResult<Office.CustomXmlPart>) => 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 un objeto CustomXmlPart que representa el elemento XML personalizado especificado. Si no hay ningún elemento XML personalizado con el identificador especificado, el método devuelve null.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

getByNamespaceAsync(ns, options, callback)

Obtiene de forma asincrónica los elementos XML personalizados especificados por su espacio de nombres.

getByNamespaceAsync(ns: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<CustomXmlPart[]>) => void): void;

Parámetros

ns

string

La URI del espacio de nombres.

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.CustomXmlPart[]>) => 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 CustomXmlPart que coinciden con el espacio de nombres especificado.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

getByNamespaceAsync(ns, callback)

Obtiene de forma asincrónica los elementos XML personalizados especificados por su espacio de nombres.

getByNamespaceAsync(ns: string, callback?: (result: AsyncResult<CustomXmlPart[]>) => void): void;

Parámetros

ns

string

La URI del espacio de nombres.

callback

(result: Office.AsyncResult<Office.CustomXmlPart[]>) => 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 CustomXmlPart que coinciden con el espacio de nombres especificado.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

Ejemplos

function showXMLPartsInNamespace() {
    Office.context.document.customXmlParts.getByNamespaceAsync(
        "http://tempuri.org", 
        function (eventArgs) {
            write("Found " + eventArgs.value.length + " parts with this namespace");
    }); 
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}