PowerPoint.CustomPropertyCollection class
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
自定义属性的集合。
- 扩展
注解
[ API 集：PowerPointApi BETA (仅预览版) ]
属性
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| items | 获取此集合中已加载的子项。 |
方法
| add(key, value) | 使用给定键创建新的 |
| delete |
删除此集合中的所有自定义属性。 |
| get |
获取集合中的自定义属性数。 |
| get |
|
| get |
|
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 重写 JavaScript |
属性详细信息
context
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
context: RequestContext;属性值
items
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取此集合中已加载的子项。
readonly items: PowerPoint.CustomProperty[];属性值
方法详细信息
add(key, value)
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
使用给定键创建新的 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()
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
删除此集合中的所有自定义属性。
deleteAll(): void;返回
void
注解
getCount()
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
获取集合中的自定义属性数。
getCount(): OfficeExtension.ClientResult<number>;返回
OfficeExtension.ClientResult<number>
集合中的自定义属性数。
注解
getItem(key)
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
CustomProperty按键获取 。
getItem(key: string): PowerPoint.CustomProperty;参数
- key
-
string
标识 CustomProperty 对象的字符串。 不区分大小写。 键的最大长度为 255 个字符。 如果参数超过 255 个字符，则此方法返回 InvalidArgument 错误。
返回
注解
getItemOrNullObject(key)
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
CustomProperty按键获取 。
CustomProperty如果 不存在，则此方法返回一个 对象，其isNullObject属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。
getItemOrNullObject(key: string): PowerPoint.CustomProperty;参数
- key
-
string
标识 CustomProperty 对象的字符串。 不区分大小写。 键的最大长度为 255 个字符。 如果参数超过 255 个字符，则此方法返回 InvalidArgument 错误。
返回
注解
load(options)
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.CustomPropertyCollection;参数
- options
-
PowerPoint.Interfaces.CustomPropertyCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions
提供要加载对象的属性的选项。
返回
load(propertyNames)
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): PowerPoint.CustomPropertyCollection;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.CustomPropertyCollection;参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
toJSON()
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，反过来，调用toJSON传递给它的 对象的 方法。) 而原始PowerPoint.CustomPropertyCollection对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 PowerPoint.Interfaces.CustomPropertyCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。
toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData;