Office.CustomXmlParts interface

  • Referência
Pacote:
office

Representa uma coleção de objetos CustomXmlPart.

Comentários

Aplicações: Word

Métodos

addAsync(xml, options, callback)

Adiciona de forma assíncrona uma nova parte XML personalizada a um arquivo.
addAsync(xml, callback)

Adiciona de forma assíncrona uma nova parte XML personalizada a um arquivo.
getByIdAsync(id, options, callback)

De forma assíncrona, obtém a parte XML personalizada especificada pelo respetivo ID.
getByIdAsync(id, callback)

De forma assíncrona, obtém a parte XML personalizada especificada pelo respetivo ID.
getByNamespaceAsync(ns, options, callback)

De forma assíncrona, obtém as partes XML personalizadas especificadas pelo respetivo espaço de nomes.
getByNamespaceAsync(ns, callback)

De forma assíncrona, obtém as partes XML personalizadas especificadas pelo respetivo espaço de nomes.

Detalhes do método

addAsync(xml, options, callback)

Adiciona de forma assíncrona uma nova parte XML personalizada a um arquivo.

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

Parâmetros

xml

string

O XML para adicionar à parte XML personalizada recém-criada.

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.CustomXmlPart>) => 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 é o objeto CustomXmlPart recentemente criado.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

addAsync(xml, callback)

Adiciona de forma assíncrona uma nova parte XML personalizada a um arquivo.

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

Parâmetros

xml

string

O XML para adicionar à parte XML personalizada recém-criada.

callback

(result: Office.AsyncResult<Office.CustomXmlPart>) => 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 é o objeto CustomXmlPart recentemente criado.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Exemplos

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)

De forma assíncrona, obtém a parte XML personalizada especificada pelo respetivo ID.

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

Parâmetros

id

string

O GUID da parte XML personalizada, inclusive chaves de abertura e fechamento.

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.CustomXmlPart>) => 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 é um objeto CustomXmlPart que representa a peça XML personalizada especificada. Se não existir uma parte XML personalizada com o ID especificado, o método devolve nulo.

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

getByIdAsync(id, callback)

De forma assíncrona, obtém a parte XML personalizada especificada pelo respetivo ID.

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

Parâmetros

id

string

O GUID da parte XML personalizada, inclusive chaves de abertura e fechamento.

callback

(result: Office.AsyncResult<Office.CustomXmlPart>) => 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 é um objeto CustomXmlPart que representa a peça XML personalizada especificada. Se não existir uma parte XML personalizada com o ID especificado, o método devolve nulo.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

getByNamespaceAsync(ns, options, callback)

De forma assíncrona, obtém as partes XML personalizadas especificadas pelo respetivo espaço de nomes.

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

Parâmetros

ns

string

O URI do namespace.

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.CustomXmlPart[]>) => 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 CustomXmlPart que correspondem ao espaço de nomes especificado.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

getByNamespaceAsync(ns, callback)

De forma assíncrona, obtém as partes XML personalizadas especificadas pelo respetivo espaço de nomes.

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

Parâmetros

ns

string

O URI do namespace.

callback

(result: Office.AsyncResult<Office.CustomXmlPart[]>) => 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 CustomXmlPart que correspondem ao espaço de nomes especificado.

Retornos

void

Comentários

Conjunto de requisitos: CustomXmlParts

Exemplos

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