PowerPoint.CustomXmlPartScopedCollection class
Коллекция настраиваемых XML-частей с заданной областью. Коллекция с заданной областью является результатом некоторых операций (например, фильтрации по пространству имен). Коллекция с заданной областью больше не может быть ограничена.
- Расширяет
Замечания
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методика
| get |
Возвращает количество настраиваемых XML-частей в этой коллекции. |
| get |
Возвращает объект на основе его идентификатора |
| get |
Возвращает по индексу |
| get |
Возвращает объект на основе его идентификатора |
| get |
Если коллекция содержит ровно один элемент, этот метод возвращает его. Если коллекция не содержит элементов или несколько элементов, этот метод возвращает ошибку |
| get |
Если коллекция содержит ровно один элемент, этот метод возвращает его. В противном случае этот метод возвращает |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Подробнее
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Стоимость недвижимости
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: PowerPoint.CustomXmlPart[];Стоимость недвижимости
Подробнее о методе
getCount()
Возвращает количество настраиваемых XML-частей в этой коллекции.
getCount(): OfficeExtension.ClientResult<number>;Возвращает
OfficeExtension.ClientResult<number>
Количество настраиваемых XML-частей в коллекции.
Замечания
getItem(id)
Возвращает объект на основе его идентификатора CustomXmlPart .
getItem(id: string): PowerPoint.CustomXmlPart;Параметры
- id
-
string
Идентификатор извлекаемого объекта.
Возвращает
Замечания
getItemAt(index)
Возвращает по индексу CustomXmlPart отсчитываемого от нуля в коллекции. Создает исключение, InvalidArgument если индекс выходит за пределы диапазона.
getItemAt(index: number): PowerPoint.CustomXmlPart;Параметры
- index
-
number
Индекс настраиваемой XML-части в коллекции.
Возвращает
Настраиваемая XML-часть по заданному индексу.
Замечания
getItemOrNullObject(id)
Возвращает объект на основе его идентификатора CustomXmlPart .
CustomXmlPart Если объект не существует, этот метод возвращает объект со свойством trueisNullObject. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getItemOrNullObject(id: string): PowerPoint.CustomXmlPart;Параметры
- id
-
string
Идентификатор извлекаемого объекта.
Возвращает
Замечания
getOnlyItem()
Если коллекция содержит ровно один элемент, этот метод возвращает его. Если коллекция не содержит элементов или несколько элементов, этот метод возвращает ошибку GeneralException .
getOnlyItem(): PowerPoint.CustomXmlPart;Возвращает
Замечания
getOnlyItemOrNullObject()
Если коллекция содержит ровно один элемент, этот метод возвращает его. В противном случае этот метод возвращает null.
getOnlyItemOrNullObject(): PowerPoint.CustomXmlPart;Возвращает
Замечания
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomXmlPartScopedCollection;Параметры
- options
-
PowerPoint.Interfaces.CustomXmlPartScopedCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
Предоставляет параметры свойств объекта для загрузки.
Возвращает
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): PowerPoint.CustomXmlPartScopedCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращает
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomXmlPartScopedCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращает
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.CustomXmlPartScopedCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как PowerPoint.Interfaces.CustomXmlPartScopedCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.
toJSON(): PowerPoint.Interfaces.CustomXmlPartScopedCollectionData;