PowerPoint.CustomPropertyCollection class
Коллекция настраиваемых свойств.
- Extends
Комментарии
Используется
Свойства
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| items | Получает загруженные дочерние элементы в этой коллекции. |
Методы
| add(key, value) | Создает новое |
| delete |
Удаляет все настраиваемые свойства в коллекции. |
| get |
Получает количество настраиваемых свойств в коллекции. |
| get |
Получает a |
| get |
Получает индекс |
| get |
Получает a |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
items
Получает загруженные дочерние элементы в этой коллекции.
readonly items: PowerPoint.CustomProperty[];Значение свойства
Сведения о методе
add(key, value)
Создает новое CustomProperty или обновляет свойство с указанным ключом.
add(key: string, value: boolean | Date | number | string): PowerPoint.CustomProperty;Параметры
- key
-
string
Строка, определяющая объект.CustomProperty Регистр не учитывается. Максимальная длина ключа — 255 символов. Более крупные строки приводят к тому, что операция завершается InvalidArgument ошибкой.
- value
-
boolean | Date | number | string
Значение CustomPropertyфайла . Если значением является строка, максимальная длина 255 символов. Более крупные строки приводят к тому, что операция завершается InvalidArgument ошибкой.
Возвращаемое значение
Комментарии
deleteAll()
Удаляет все настраиваемые свойства в коллекции.
deleteAll(): void;Возвращаемое значение
void
Комментарии
getCount()
Получает количество настраиваемых свойств в коллекции.
getCount(): OfficeExtension.ClientResult<number>;Возвращаемое значение
OfficeExtension.ClientResult<number>
Количество настраиваемых свойств в коллекции.
Комментарии
getItem(key)
Получает a CustomProperty по своему ключу.
getItem(key: string): PowerPoint.CustomProperty;Параметры
- key
-
string
Строка, определяющая объект.CustomProperty Регистр не учитывается. Максимальная длина клавиш — 255 символов. Если аргумент превышает 255 символов, этот метод возвращает InvalidArgument ошибку.
Возвращаемое значение
Комментарии
getItemAt(index)
Получает индекс CustomProperty коллекции, отсчитывающий от нуля. Создает InvalidArgument исключение, когда индекс выходит за пределы допустимого диапазона.
getItemAt(index: number): PowerPoint.CustomProperty;Параметры
- index
-
number
Индекс настраиваемого свойства в коллекции.
Возвращаемое значение
Настраиваемое свойство в заданном индексе.
Комментарии
getItemOrNullObject(key)
Получает a CustomProperty по своему ключу. Если не CustomProperty существует, этот метод возвращает объект со свойством isNullObject , установленным в trueзначение . Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getItemOrNullObject(key: string): PowerPoint.CustomProperty;Параметры
- key
-
string
Строка, определяющая объект.CustomProperty Регистр не учитывается. Максимальная длина клавиш — 255 символов. Если аргумент превышает 255 символов, этот метод возвращает InvalidArgument ошибку.
Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomPropertyCollection;Параметры
- options
-
PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): PowerPoint.CustomPropertyCollection;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomPropertyCollection;Параметры
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.CustomPropertyCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как PowerPoint.Interfaces.CustomPropertyCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.
toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData;