Excel.CustomXmlPartCollection interface

Uma coleção de partes XML personalizadas.

Métodos

add(xml)

Adiciona uma nova parte XML personalizada à pasta de trabalho.

getByNamespace(namespaceUri)

Obtém uma nova coleção com escopo de partes XML personalizadas cujos namespaces correspondem ao namespace especificado.

getCount()

Obtém o número de partes CustomXml na coleção.

getItem(id)

Obtém uma parte XML personalizada com base em sua ID.

getItemOrNullObject(id)

Obtém uma parte XML personalizada com base em sua ID. Se o CustomXmlPart não existir, a propriedade isNull do objeto Return será true.

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

Detalhes do método

add(xml)

Adiciona uma nova parte XML personalizada à pasta de trabalho.

add(xml: string): CustomXmlPart;

Parâmetros

xml
string

Conteúdo XML. Deve ser um fragmento XML válido.

Retornos

Exemplos

async function main(context: Excel.RequestContext) {
    // You must have the xmlns attribute to populate the 
    // CustomXml.namespaceUri property.
    let originalXml = "<Reviewers xmlns='http://schemas.contoso.com/review/1.0'><Reviewer>Juan</Reviewer><Reviewer>Hong</Reviewer><Reviewer>Sally</Reviewer></Reviewers>";
    let customXmlPart = context.workbook.customXmlParts.add(originalXml);
    customXmlPart.load("id");
    let xmlBlob = customXmlPart.getXml();

    await context.sync();

    let readableXml = addLineBreaksToXML(xmlBlob.value);
    $("#display-xml").text(readableXml);

    // Store the XML part's ID in a setting.
    let settings = context.workbook.settings;
    settings.add("ContosoReviewXmlPartId", customXmlPart.id);

    await context.sync();
}

getByNamespace(namespaceUri)

Obtém uma nova coleção com escopo de partes XML personalizadas cujos namespaces correspondem ao namespace especificado.

getByNamespace(namespaceUri: string): CustomXmlPartScopedCollection;

Parâmetros

namespaceUri
string

Este deve ser um URI de esquema totalmente qualificado; por exemplo, " http://schemas.contoso.com/review/1.0 ".

Retornos

getCount()

Obtém o número de partes CustomXml na coleção.

getCount(): ClientResult<number>;

Retornos

ClientResult<number>

getItem(id)

Obtém uma parte XML personalizada com base em sua ID.

getItem(id: string): CustomXmlPart;

Parâmetros

id
string

ID do objeto a ser recuperado.

Retornos

getItemOrNullObject(id)

Obtém uma parte XML personalizada com base em sua ID. Se o CustomXmlPart não existir, a propriedade isNull do objeto Return será true.

getItemOrNullObject(id: string): CustomXmlPart;

Parâmetros

id
string

ID do objeto a ser recuperado.

Retornos

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): void;

Parâmetros

propertyNames
string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

void