PowerPoint.CustomPropertyCollection class
自定义属性的集合。
方法
| add(key, value) | 使用给定的键新建 |
| delete |
删除此集合中的所有自定义属性。 |
| get |
获取集合中自定义属性的数量。 |
| get |
按键获取 a |
| get |
按集合中从零开始的索引获取 a |
| get |
按键获取 a |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
context
items
方法详细信息
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()
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)
按集合中从零开始的索引获取 a 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”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。
toJSON(): PowerPoint.Interfaces.CustomPropertyCollectionData;