Office.CustomXmlPart interface

  • Referencia
Paquete:
office

Representa un único objeto CustomXMLPart en una colección Office.CustomXmlParts .

Comentarios

Aplicaciones: Word

Propiedades

builtIn

True, si el elemento XML personalizado está integrado; de lo contrario, false.
id

Obtiene el GUID del elemento CustomXMLPart.
namespaceManager

Obtiene el conjunto de asignaciones de prefijos de espacio de nombres (Office.CustomXmlPrefixMappings) que se usan en el objeto CustomXmlPart actual.

Métodos

addHandlerAsync(eventType, handler, options, callback)

Agrega un controlador de eventos al objeto mediante el tipo de evento especificado.
addHandlerAsync(eventType, handler, callback)

Agrega un controlador de eventos al objeto mediante el tipo de evento especificado.
deleteAsync(options, callback)

Elimina el elemento XML personalizado.
deleteAsync(callback)

Elimina el elemento XML personalizado.
getNodesAsync(xPath, options, callback)

Obtiene de forma asincrónica cualquier objeto CustomXmlNodes de un elemento XML personalizado que coincide con la expresión XPath especificada.
getNodesAsync(xPath, callback)

Obtiene de forma asincrónica cualquier objeto CustomXmlNodes de un elemento XML personalizado que coincide con la expresión XPath especificada.
getXmlAsync(options, callback)

Obtiene de forma asincrónica el contenido XML de un elemento XML personalizado.
getXmlAsync(callback)

Obtiene de forma asincrónica el contenido XML de un elemento XML personalizado.
removeHandlerAsync(eventType, handler, options, callback)

Quita un controlador de eventos para el tipo de evento especificado.
removeHandlerAsync(eventType, handler, callback)

Quita un controlador de eventos para el tipo de evento especificado.

Detalles de las propiedades

builtIn

True, si el elemento XML personalizado está integrado; de lo contrario, false.

builtIn: boolean;

Valor de propiedad

boolean

Ejemplos

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

Obtiene el GUID del elemento CustomXMLPart.

id: string;

Valor de propiedad

string

Ejemplos

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

Obtiene el conjunto de asignaciones de prefijos de espacio de nombres (Office.CustomXmlPrefixMappings) que se usan en el objeto CustomXmlPart actual.

namespaceManager: CustomXmlPrefixMappings;

Valor de propiedad

Office.CustomXmlPrefixMappings

Ejemplos

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

Detalles del método

addHandlerAsync(eventType, handler, options, callback)

Agrega un controlador de eventos al objeto mediante el tipo de evento especificado.

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

Parámetros

eventType
Office.EventType

Especifica el tipo de evento que se debe agregar. Para un objeto CustomXmlPart, el parámetro eventType se puede especificar como Office.EventType.NodeDeleted, Office.EventType.NodeInsertedy Office.EventType.NodeReplaced.

handler

(result: any) => void

Función del controlador de eventos que se va a agregar, cuyo único parámetro es de tipo Office.NodeDeletedEventArgs, Office.NodeInsertedEventArgs o Office.NodeReplacedEventArgs

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

Puede agregar varios controladores de eventos para el eventType especificado siempre y cuando el nombre de cada función de controlador de eventos sea único.

addHandlerAsync(eventType, handler, callback)

Agrega un controlador de eventos al objeto mediante el tipo de evento especificado.

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

Parámetros

eventType
Office.EventType

Especifica el tipo de evento que se debe agregar. Para un objeto CustomXmlPart, el parámetro eventType se puede especificar como Office.EventType.NodeDeleted, Office.EventType.NodeInsertedy Office.EventType.NodeReplaced.

handler

(result: any) => void

Función del controlador de eventos que se va a agregar, cuyo único parámetro es de tipo Office.NodeDeletedEventArgs, Office.NodeInsertedEventArgs o Office.NodeReplacedEventArgs

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

Puede agregar varios controladores de eventos para el eventType especificado siempre y cuando el nombre de cada función de controlador de eventos sea único.

Ejemplos

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

Elimina el elemento XML personalizado.

deleteAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => 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<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

deleteAsync(callback)

Elimina el elemento XML personalizado.

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

Parámetros

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

Obtiene de forma asincrónica cualquier objeto CustomXmlNodes de un elemento XML personalizado que coincide con la expresión XPath especificada.

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

Parámetros

xPath

string

Una expresión XPath que especifica los nodos que desea devolver. 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 parámetro xPath.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

getNodesAsync(xPath, callback)

Obtiene de forma asincrónica cualquier objeto CustomXmlNodes de un elemento XML personalizado que coincide con la expresión XPath especificada.

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

Parámetros

xPath

string

Una expresión XPath que especifica los nodos que desea devolver. Obligatorio.

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 parámetro xPath.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

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

getXmlAsync(options, callback)

Obtiene de forma asincrónica el contenido XML de un elemento XML personalizado.

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

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 XML del objeto CustomXmlPart al que se hace referencia.

Devoluciones

void

Comentarios

Conjunto de requisitos: CustomXmlParts

getXmlAsync(callback)

Obtiene de forma asincrónica el contenido XML de un elemento XML personalizado.

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

Parámetros

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 XML del objeto CustomXmlPart al que se hace referencia.

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

removeHandlerAsync(eventType, handler, options, callback)

Quita un controlador de eventos para el tipo de evento especificado.

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

Parámetros

eventType
Office.EventType

Especifica el tipo de evento que se debe quitar. Para un objeto CustomXmlPart, el parámetro eventType se puede especificar como Office.EventType.NodeDeleted, Office.EventType.NodeInsertedy Office.EventType.NodeReplaced.

handler

(result: any) => void

Nombre del controlador que se va a quitar.

options
Office.RemoveHandlerOptions

Proporciona opciones para determinar qué controladores o controladores de eventos se quitan.

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

removeHandlerAsync(eventType, handler, callback)

Quita un controlador de eventos para el tipo de evento especificado.

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

Parámetros

eventType
Office.EventType

Especifica el tipo de evento que se debe quitar. Para un objeto CustomXmlPart, el parámetro eventType se puede especificar como Office.EventType.NodeDeleted, Office.EventType.NodeInsertedy Office.EventType.NodeReplaced.

handler

(result: any) => void

Nombre del controlador que se va a quitar.

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