PowerPoint.CustomXmlPartCollection class
Коллекция настраиваемых XML-частей.
- Extends
Комментарии
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| add(xml) | Добавляет новый |
| get |
Получает новую ограниченную коллекцию пользовательских XML-частей, пространства имен которых совпадают с указанным пространством имен. |
| get |
Возвращает количество настраиваемых XML-частей в коллекции. |
| get |
Возвращает объект на основе его идентификатора |
| get |
Возвращает по индексу |
| get |
Возвращает объект на основе его идентификатора |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: PowerPoint.CustomXmlPart[];Значение свойства
Сведения о методе
add(xml)
Добавляет новый CustomXmlPart объект в коллекцию.
add(xml: string): PowerPoint.CustomXmlPart;Параметры
- xml
-
string
XML-содержимое. Должен быть допустимым ФРАГМЕНТом XML. Если фрагмент XML недопустим, этот метод возвращает ошибку GeneralException .
Возвращаемое значение
Комментарии
getByNamespace(namespaceUri)
Получает новую ограниченную коллекцию пользовательских XML-частей, пространства имен которых совпадают с указанным пространством имен.
getByNamespace(namespaceUri: string): PowerPoint.CustomXmlPartScopedCollection;Параметры
- namespaceUri
-
string
Это должен быть полный URI схемы, например "http://schemas.contoso.com/review/1.0".
Возвращаемое значение
Комментарии
getCount()
Возвращает количество настраиваемых XML-частей в коллекции.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Количество настраиваемых XML-частей в коллекции.
Комментарии
getItem(id)
Возвращает объект на основе его идентификатора CustomXmlPart .
getItem(id: string): PowerPoint.CustomXmlPart;Параметры
- id
-
string
Идентификатор извлекаемого объекта.
Возвращаемое значение
Комментарии
getItemAt(index)
Примечание
Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.
Возвращает по индексу CustomXmlPart отсчитываемого от нуля в коллекции. Создает исключение, InvalidArgument если индекс выходит за пределы диапазона.
getItemAt(index: number): PowerPoint.CustomXmlPart;Параметры
- index
-
number
Индекс настраиваемой XML-части в коллекции.
Возвращаемое значение
Настраиваемая XML-часть по заданному индексу.
Комментарии
[ Набор API: PowerPointApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ) ]
getItemOrNullObject(id)
Возвращает объект на основе его идентификатора CustomXmlPart .
CustomXmlPart Если объект не существует, этот метод возвращает объект со свойством trueisNullObject. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getItemOrNullObject(id: string): PowerPoint.CustomXmlPart;Параметры
- id
-
string
Идентификатор извлекаемого объекта.
Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomXmlPartCollection;Параметры
- options
-
PowerPoint.Interfaces.CustomXmlPartCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): PowerPoint.CustomXmlPartCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomXmlPartCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.CustomXmlPartCollection объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как PowerPoint.Interfaces.CustomXmlPartCollectionData), содержащий массив "items" с мелкими копиями всех загруженных свойств из элементов коллекции.
toJSON(): PowerPoint.Interfaces.CustomXmlPartCollectionData;