PowerPoint.CustomProperty class
表示自定义属性。
注解
使用方
属性
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| key | 唯一标识自定义属性的字符串。 |
| type | 用于自定义属性的值的类型。 |
| value | 自定义属性的值。 如果值是字符串，则最大长度为 255 个字符。 较大的字符串会导致操作失败并显示 |
方法
| delete() | 删除 custom property 对象。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
context
key
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()
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;