通过

PowerPoint.CustomProperty class

  • 参考
包:
powerpoint

表示自定义属性。

扩展
OfficeExtension.ClientObject

注解

[ API 集：PowerPointApi 1.7 ]

属性

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
key

唯一标识自定义属性的字符串。
type

用于自定义属性的值的类型。
value

自定义属性的值。 如果值为字符串，则最大长度为 255 个字符。 较大的字符串会导致操作失败并出现 InvalidArgument 错误。

方法

delete()

删除 custom property 对象。
load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始PowerPoint.CustomProperty对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 PowerPoint.Interfaces.CustomPropertyData) ，其中包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

PowerPoint.RequestContext

key

唯一标识自定义属性的字符串。

readonly key: string;

属性值

string

注解

[ API 集：PowerPointApi 1.7 ]

type

用于自定义属性的值的类型。

readonly type: PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String";

属性值

PowerPoint.DocumentPropertyType | "Boolean" | "Date" | "Number" | "String"

注解

[ API 集：PowerPointApi 1.7 ]

value

自定义属性的值。 如果值为字符串，则最大长度为 255 个字符。 较大的字符串会导致操作失败并出现 InvalidArgument 错误。

value: boolean | Date | number | string;

属性值

boolean | Date | number | string

注解

[ API 集：PowerPointApi 1.7 ]

方法详细信息

delete()

删除 custom property 对象。

delete(): void;

返回

void

注解

[ API 集：PowerPointApi 1.7 ]

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: PowerPoint.Interfaces.CustomPropertyLoadOptions): PowerPoint.CustomProperty;

参数

options
PowerPoint.Interfaces.CustomPropertyLoadOptions

提供要加载对象的属性的选项。

返回

PowerPoint.CustomProperty

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): PowerPoint.CustomProperty;

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

PowerPoint.CustomProperty

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.CustomProperty;

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

PowerPoint.CustomProperty

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始PowerPoint.CustomProperty对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 PowerPoint.Interfaces.CustomPropertyData) ，其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): PowerPoint.Interfaces.CustomPropertyData;

返回

PowerPoint.Interfaces.CustomPropertyData