PowerPoint.CustomProperty class
Представляет пользовательское свойство.
- Extends
Комментарии
[ Набор API: PowerPointApi 1.7 ]
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| key | Строка, однозначно идентифицирующая пользовательское свойство. |
| type | Тип значения, используемого для настраиваемого свойства. |
| value | Значение настраиваемого свойства. Если значение является строкой, максимальная длина 255 символов. Большие строки приводят к сбою операции с ошибкой |
Методы
| delete() | Удаляет настраиваемое свойство. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
key
Строка, однозначно идентифицирующая пользовательское свойство.
readonly key: string;Значение свойства
string
Комментарии
type
Тип значения, используемого для настраиваемого свойства.
readonly type: PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String";Значение свойства
PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String"
Комментарии
value
Значение настраиваемого свойства. Если значение является строкой, максимальная длина 255 символов. Большие строки приводят к сбою операции с ошибкой InvalidArgument .
value: boolean | Date | number | string;Значение свойства
boolean | Date | number | string
Комментарии
Сведения о методе
delete()
Удаляет настраиваемое свойство.
delete(): void;Возвращаемое значение
void
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: PowerPoint.Interfaces.CustomPropertyLoadOptions): PowerPoint.CustomProperty;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): PowerPoint.CustomProperty;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.CustomProperty;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.CustomProperty объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как PowerPoint.Interfaces.CustomPropertyData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): PowerPoint.Interfaces.CustomPropertyData;Возвращаемое значение
Office Add-ins