Excel.CustomProperty class
表示自定义属性。
- 扩展
注解
属性
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| key | 自定义属性的键。 密钥限制为 255 个字符，Excel web 版 (其他平台上的较大键会自动剪裁为 255 个字符) 。 |
| type | 用于自定义属性的值的类型。 |
| value | 自定义属性的值。 此值限制为 255 个字符，Excel web 版 (其他平台上的较大值会自动剪裁为 255 个字符) 。 |
方法
| delete() | 删除 custom property 对象。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。 |
| set(properties) | 基于现有的已加载对象，同时对对象设置多个属性。 |
| toJSON() | 重写 JavaScript |
属性详细信息
context
key
自定义属性的键。 密钥限制为 255 个字符，Excel web 版 (其他平台上的较大键会自动剪裁为 255 个字符) 。
readonly key: string;属性值
string
注解
type
用于自定义属性的值的类型。
readonly type: Excel.DocumentPropertyType | "Number" | "Boolean" | "Date" | "String" | "Float";属性值
Excel.DocumentPropertyType | "Number" | "Boolean" | "Date" | "String" | "Float"
注解
value
自定义属性的值。 此值限制为 255 个字符，Excel web 版 (其他平台上的较大值会自动剪裁为 255 个字符) 。
value: any;属性值
any
注解
方法详细信息
delete()
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.CustomPropertyLoadOptions): Excel.CustomProperty;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.CustomProperty;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.CustomProperty;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties: Interfaces.CustomPropertyUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Excel.Interfaces.CustomPropertyUpdateData
一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。
返回
void
set(properties)
基于现有的已加载对象，同时对对象设置多个属性。
set(properties: Excel.CustomProperty): void;参数
- properties
- Excel.CustomProperty
返回
void
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.CustomProperty对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.CustomPropertyData) ，其中包含原始对象中任何已加载子属性的浅表副本。
toJSON(): Excel.Interfaces.CustomPropertyData;