Excel.CustomXmlPartCollection interface

Коллекция настраиваемых XML-частей.

Методы

add(xml)

Добавляет новую пользовательскую XML-часть в книгу.

getByNamespace(namespaceUri)

Получает новую ограниченную коллекцию пользовательских XML-частей, пространства имен которых совпадают с указанным пространством имен.

getCount()

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

getItem(id)

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

getItemOrNullObject(id)

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

load(propertyNames)

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

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

add(xml)

Добавляет новую пользовательскую XML-часть в книгу.

add(xml: string): CustomXmlPart;

Параметры

xml
string

XML-контент. Должен быть допустимым фрагментом XML.

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

Примеры

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)

Получает новую ограниченную коллекцию пользовательских XML-частей, пространства имен которых совпадают с указанным пространством имен.

getByNamespace(namespaceUri: string): CustomXmlPartScopedCollection;

Параметры

namespaceUri
string

Это должен быть полный URI схемы; Например, " http://schemas.contoso.com/review/1.0 ".

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

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

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

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

load(propertyNames)

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

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

Параметры

propertyNames
string | string[]

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

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

void