Excel.CustomXmlPartScopedCollection interface

Uma coleção com escopo de partes XML personalizadas. Uma coleção com escopo é o resultado de alguma operação (por exemplo, filtragem por namespace). Uma coleção com escopo não pode ser mais delimitada.

Métodos

getCount()

Obtém o número de partes CustomXML nesta 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.

getOnlyItem()

Se o conjunto contiver exatamente um item, esse método o retornará. Caso contrário, esse método gera um erro.

getOnlyItemOrNullObject()

Se o conjunto contiver exatamente um item, esse método o retornará. Caso contrário, esse método retornará NULL.

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

getCount()

Obtém o número de partes CustomXML nesta 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

Exemplos

async function main(context: Excel.RequestContext) {
    let settings = context.workbook.settings;
    let xmlPartIDSetting = settings.getItemOrNullObject("ContosoReviewXmlPartId").load("value");
    await context.sync();

    if (xmlPartIDSetting.value) {   
        let customXmlPart = context.workbook.customXmlParts.getItem(xmlPartIDSetting.value);
        let xmlBlob = customXmlPart.getXml();
        customXmlPart.delete();
        customXmlPart = context.workbook.customXmlParts.getItemOrNullObject(xmlPartIDSetting.value);

        await context.sync();

        if (customXmlPart.isNullObject) {
            $("#display-xml").text(`The XML part with the id ${xmlPartIDSetting.value} has been deleted.`);

            // Delete the unneeded setting too.
            xmlPartIDSetting.delete();            
        } else {
            let readableXml = addLineBreaksToXML(xmlBlob.value);
            let strangeMessage = `This is strange. The XML part with the id ${xmlPartIDSetting.value} has not been deleted:\n${readableXml}`
            $("#display-xml").text(strangeMessage);
        }

        await context.sync();
    }
}

getOnlyItem()

Se o conjunto contiver exatamente um item, esse método o retornará. Caso contrário, esse método gera um erro.

getOnlyItem(): CustomXmlPart;

Retornos

getOnlyItemOrNullObject()

Se o conjunto contiver exatamente um item, esse método o retornará. Caso contrário, esse método retornará NULL.

getOnlyItemOrNullObject(): CustomXmlPart;

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