Word.CustomXmlPartScopedCollection class

Пакет:

word

Содержит коллекцию Word. Объекты CustomXmlPart с определенным пространством имен.

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApi 1.4 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-custom-xml-part-ns.yaml

// Original XML: <Reviewers xmlns='http://schemas.contoso.com/review/1.0'><Reviewer>Juan</Reviewer><Reviewer>Hong</Reviewer><Reviewer>Sally</Reviewer></Reviewers>

// Gets the custom XML parts with the specified namespace URI.
await Word.run(async (context) => {
  const namespaceUri = "http://schemas.contoso.com/review/1.0";
  console.log(`Specified namespace URI: ${namespaceUri}`);
  const scopedCustomXmlParts: Word.CustomXmlPartScopedCollection =
    context.document.customXmlParts.getByNamespace(namespaceUri);
  scopedCustomXmlParts.load("items");
  await context.sync();

  console.log(`Number of custom XML parts found with this namespace: ${!scopedCustomXmlParts.items ? 0 : scopedCustomXmlParts.items.length}`);
});

Свойства

context	Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
items	Получает загруженные дочерние элементы в этой коллекции.

Методы

getCount()	Возвращает число элементов в коллекции.
getItem(id)	Получает пользовательскую XML-часть по идентификатору.
getItemOrNullObject(id)	Получает пользовательскую XML-часть по идентификатору. Если элемент CustomXmlPart не существует в коллекции, то этот метод вернет объект со свойством , для которых isNullObject задано значение true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getOnlyItem()	Если коллекция содержит ровно один элемент, этот метод возвращает его. В противном случае этот метод выдает ошибку.
getOnlyItemOrNullObject()	Если коллекция содержит ровно один элемент, этот метод возвращает его. В противном случае этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.CustomXmlPartScopedCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.CustomXmlPartScopedCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

Сведения о свойстве

context

Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.

context: RequestContext;

Значение свойства

Word.RequestContext

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: Word.CustomXmlPart[];

Значение свойства

Word.CustomXmlPart[]

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

getCount()

Возвращает число элементов в коллекции.

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

Комментарии

[ Набор API: WordApi 1.4 ]

getItem(id)

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

getItem(id: string): Word.CustomXmlPart;

Параметры

id

string

Идентификатор извлекаемой пользовательской XML-части.

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

Word.CustomXmlPart

Комментарии

[ Набор API: WordApi 1.4 ]

getItemOrNullObject(id)

Получает пользовательскую XML-часть по идентификатору. Если элемент CustomXmlPart не существует в коллекции, то этот метод вернет объект со свойством , для которых isNullObject задано значение true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getItemOrNullObject(id: string): Word.CustomXmlPart;

Параметры

id

string

Обязательно. Идентификатор извлекаемого объекта.

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

Word.CustomXmlPart

Комментарии

[ Набор API: WordApi 1.4 ]

getOnlyItem()

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

getOnlyItem(): Word.CustomXmlPart;

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

Word.CustomXmlPart

Комментарии

[ Набор API: WordApi 1.4 ]

getOnlyItemOrNullObject()

Если коллекция содержит ровно один элемент, этот метод возвращает его. В противном случае этот метод вернет объект со свойством isNullObjecttrue. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getOnlyItemOrNullObject(): Word.CustomXmlPart;

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

Word.CustomXmlPart

Комментарии

[ Набор API: WordApi 1.4 ]

load(options)

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

load(options?: Word.Interfaces.CustomXmlPartScopedCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlPartScopedCollection;

Параметры

options

Word.Interfaces.CustomXmlPartScopedCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions

Предоставляет параметры свойств объекта для загрузки.

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

Word.CustomXmlPartScopedCollection

load(propertyNames)

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

load(propertyNames?: string | string[]): Word.CustomXmlPartScopedCollection;

Параметры

propertyNames

string | string[]

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

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

Word.CustomXmlPartScopedCollection

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomXmlPartScopedCollection;

Параметры

propertyNamesAndPaths

OfficeExtension.LoadOption

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

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

Word.CustomXmlPartScopedCollection

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.CustomXmlPartScopedCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.CustomXmlPartScopedCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.

toJSON(): Word.Interfaces.CustomXmlPartScopedCollectionData;

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

Word.Interfaces.CustomXmlPartScopedCollectionData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.

track(): Word.CustomXmlPartScopedCollection;

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

Word.CustomXmlPartScopedCollection

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.

untrack(): Word.CustomXmlPartScopedCollection;

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

Word.CustomXmlPartScopedCollection