PowerPoint.CustomXmlPartScopedCollection class
Ограниченная коллекция пользовательских частей XML. Коллекция с заданной областью является результатом некоторой операции (например, фильтрации по пространству имен). Для коллекции с заданной областью невозможно установить какую-либо дальнейшую область.
- Extends
Комментарии
Используется
Свойства
| 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 существует, этот метод возвращает объект со свойством isNullObject , установленным в trueзначение . Дополнительные сведения см. в разделе Методы и свойства *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;