Share via

Office.CustomXmlPart interface

  • Referência
Pacote:
office

Representa um único CustomXMLPart em uma coleção Office.CustomXmlParts .

Comentários

Aplicativos: Word

Propriedades

builtIn

True, se a parte XML personalizada for interna; caso contrário, false.
id

Obtém o GUID do CustomXMLPart.
namespaceManager

Obtém o conjunto de mapeamentos de prefixo namespace (Office.CustomXmlPrefixMappings) usados em relação ao CustomXmlPart atual.

Métodos

addHandlerAsync(eventType, handler, options, callback)

Adiciona um manipulador de eventos ao objeto usando o tipo de evento especificado.
addHandlerAsync(eventType, handler, callback)

Adiciona um manipulador de eventos ao objeto usando o tipo de evento especificado.
deleteAsync(options, callback)

Exclui a Parte XML Personalizada.
deleteAsync(callback)

Exclui a Parte XML Personalizada.
getNodesAsync(xPath, options, callback)

Obtém de forma assíncrona quaisquer CustomXmlNodes nesta parte XML personalizada que correspondam ao XPath especificado.
getNodesAsync(xPath, callback)

Obtém de forma assíncrona quaisquer CustomXmlNodes nesta parte XML personalizada que correspondam ao XPath especificado.
getXmlAsync(options, callback)

Obtém de forma assíncrona o XML dentro desta parte XML personalizada.
getXmlAsync(callback)

Obtém de forma assíncrona o XML dentro desta parte XML personalizada.
removeHandlerAsync(eventType, handler, options, callback)

Remove um manipulador de eventos para o tipo de evento especificado.
removeHandlerAsync(eventType, handler, callback)

Remove um manipulador de eventos para o tipo de evento especificado.

Detalhes da propriedade

builtIn

True, se a parte XML personalizada for interna; caso contrário, false.

builtIn: boolean;

Valor da propriedade

boolean

Exemplos

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

Obtém o GUID do CustomXMLPart.

id: string;

Valor da propriedade

string

Exemplos

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

Obtém o conjunto de mapeamentos de prefixo namespace (Office.CustomXmlPrefixMappings) usados em relação ao CustomXmlPart atual.

namespaceManager: CustomXmlPrefixMappings;

Valor da propriedade

Office.CustomXmlPrefixMappings

Exemplos

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

Detalhes do método

addHandlerAsync(eventType, handler, options, callback)

Adiciona um manipulador de eventos ao objeto usando o 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 o tipo de evento a ser adicionado. Para um objeto CustomXmlPart, o parâmetro eventType pode ser especificado como Office.EventType.NodeDeleted, Office.EventType.NodeInsertede Office.EventType.NodeReplaced.

handler

(result: any) => void

A função do manipulador de eventos a ser adicionada, cujo único parâmetro é do tipo Office.NodeletedEventArgs, Office.NodeInsertedEventArgs ou Office.NodeReplacedEventArgs

options
Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para uso em um retorno de chamada.

callback

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

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

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Você pode adicionar vários manipuladores de eventos para o eventType especificado desde que o nome de cada função do manipulador de eventos seja exclusivo.

addHandlerAsync(eventType, handler, callback)

Adiciona um manipulador de eventos ao objeto usando o tipo de evento especificado.

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

Parâmetros

eventType
Office.EventType

Especifica o tipo de evento a ser adicionado. Para um objeto CustomXmlPart, o parâmetro eventType pode ser especificado como Office.EventType.NodeDeleted, Office.EventType.NodeInsertede Office.EventType.NodeReplaced.

handler

(result: any) => void

A função do manipulador de eventos a ser adicionada, cujo único parâmetro é do tipo Office.NodeletedEventArgs, Office.NodeInsertedEventArgs ou Office.NodeReplacedEventArgs

callback

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

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

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Você pode adicionar vários manipuladores de eventos para o eventType especificado desde que o nome de cada função do manipulador de eventos seja exclusivo.

Exemplos

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

Exclui a Parte XML Personalizada.

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

Parâmetros

options
Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para uso em um retorno de chamada.

callback

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

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

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

deleteAsync(callback)

Exclui a Parte XML Personalizada.

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

Parâmetros

callback

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

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

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Exemplos

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)

Obtém de forma assíncrona quaisquer CustomXmlNodes nesta parte XML personalizada que correspondam ao XPath especificado.

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

Parâmetros

xPath

string

Uma expressão XPath que especifica os nós que você deseja retornar. Obrigatório.

options
Office.AsyncContextOptions

Fornece uma opção para preservar dados de contexto de qualquer tipo, inalterados, para uso em um retorno de chamada.

callback

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

Opcional. Uma função que é invocada quando o retorno de chamada retorna, 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 passada para o parâmetro xPath.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

getNodesAsync(xPath, callback)

Obtém de forma assíncrona quaisquer CustomXmlNodes nesta parte XML personalizada que correspondam ao XPath especificado.

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

Parâmetros

xPath

string

Uma expressão XPath que especifica os nós que você deseja retornar. Obrigatório.

callback

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

Opcional. Uma função que é invocada quando o retorno de chamada retorna, 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 passada para o parâmetro xPath.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

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

getXmlAsync(options, callback)

Obtém de forma assíncrona o XML dentro desta parte XML personalizada.

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 uso em um retorno de chamada.

callback

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

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é uma cadeia de caracteres que contém o XML do objeto CustomXmlPart referenciado.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

getXmlAsync(callback)

Obtém de forma assíncrona o XML dentro desta parte XML personalizada.

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

Parâmetros

callback

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

Opcional. Uma função que é invocada quando o retorno de chamada retorna, cujo único parâmetro é do tipo Office.AsyncResult. A value propriedade do resultado é uma cadeia de caracteres que contém o XML do objeto CustomXmlPart referenciado.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Exemplos

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)

Remove um manipulador de eventos para o 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 o tipo de evento a ser removido. Para um objeto CustomXmlPart, o parâmetro eventType pode ser especificado como Office.EventType.NodeDeleted, Office.EventType.NodeInsertede Office.EventType.NodeReplaced.

handler

(result: any) => void

O nome do manipulador a ser removido.

options
Office.RemoveHandlerOptions

Fornece opções para determinar quais manipuladores ou manipuladores de eventos são removidos.

callback

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

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

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

removeHandlerAsync(eventType, handler, callback)

Remove um manipulador de eventos para o tipo de evento especificado.

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

Parâmetros

eventType
Office.EventType

Especifica o tipo de evento a ser removido. Para um objeto CustomXmlPart, o parâmetro eventType pode ser especificado como Office.EventType.NodeDeleted, Office.EventType.NodeInsertede Office.EventType.NodeReplaced.

handler

(result: any) => void

O nome do manipulador a ser removido.

callback

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

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

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Exemplos

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