Excel.CustomXmlPartScopedCollection interface

Набор настраиваемых XML-частей с ограниченной областью действия. Набор с ограниченной областью является результатом некоторой операции (например, фильтрации по пространству имен). Коллекция с ограниченной областью действия не может быть задана.

Методы

getCount()

Получает количество частей CustomXML в этой коллекции.

getItem(id)

Получает пользовательскую XML-часть по идентификатору.

getItemOrNullObject(id)

Получает пользовательскую XML-часть по идентификатору. Если CustomXmlPart не существует, свойство isNull возвращаемого объекта будет иметь значение true.

getOnlyItem()

Если коллекция содержит ровно один элемент, этот метод возвращает его. В противном случае этот метод выдает ошибку.

getOnlyItemOrNullObject()

Если коллекция содержит ровно один элемент, этот метод возвращает его. В противном случае этот метод возвращает значение null.

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. context.sync()Перед чтением свойств необходимо вызвать метод.

Сведения о методе

getCount()

Получает количество частей CustomXML в этой коллекции.

getCount(): ClientResult<number>;

Возвращаемое значение

ClientResult<number>

getItem(id)

Получает пользовательскую XML-часть по идентификатору.

getItem(id: string): CustomXmlPart;

Параметры

id
string

ИДЕНТИФИКАТОР получаемого объекта.

Возвращаемое значение

getItemOrNullObject(id)

Получает пользовательскую XML-часть по идентификатору. Если CustomXmlPart не существует, свойство isNull возвращаемого объекта будет иметь значение true.

getItemOrNullObject(id: string): CustomXmlPart;

Параметры

id
string

ИДЕНТИФИКАТОР получаемого объекта.

Возвращаемое значение

Примеры

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

Если коллекция содержит ровно один элемент, этот метод возвращает его. В противном случае этот метод выдает ошибку.

getOnlyItem(): CustomXmlPart;

Возвращаемое значение

getOnlyItemOrNullObject()

Если коллекция содержит ровно один элемент, этот метод возвращает его. В противном случае этот метод возвращает значение null.

getOnlyItemOrNullObject(): CustomXmlPart;

Возвращаемое значение

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. context.sync()Перед чтением свойств необходимо вызвать метод.

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

Параметры

propertyNames
string | string[]

Строка, разделенная запятыми, или массив строк, указывающий свойства для загрузки.

Возвращаемое значение

void