Excel.AllowEditRange class
表示 AllowEditRange 在工作表中找到的对象。 此对象适用于工作表保护属性。 启用工作表保护后， AllowEditRange 可以使用 对象来允许编辑特定区域，同时对工作表的其余部分保持保护。
- 扩展
注解
属性
| address | 指定与 对象关联的范围。 必须禁用或暂停工作表保护才能使此方法正常工作。 如果启用了工作表保护但未暂停，则此方法将 |
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| is |
指定对象是否受密码保护。 |
| title | 指定 对象的标题。 必须禁用或暂停工作表保护才能使此方法正常工作。 如果工作表保护已启用且未暂停，则此方法将 |
方法
| delete() | 从 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| pause |
暂停当前会话中用户的 对象的工作表保护。 如果未启用工作表保护或已暂停，则此方法不执行任何操作。 如果工作表保护无法暂停，此方法将引发错误 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。 |
| set(properties) | 基于现有的已加载对象，同时对对象设置多个属性。 |
| set |
更改与 对象关联的密码。 将密码字符串设置为空 (“”) 或 |
| toJSON() | 重写 JavaScript |
属性详细信息
address
指定与 对象关联的范围。 必须禁用或暂停工作表保护才能使此方法正常工作。 如果启用了工作表保护但未暂停，则此方法将 AccessDenied 引发错误，并且无法设置范围。
address: string;属性值
string
注解
context
isPasswordProtected
title
指定 对象的标题。 必须禁用或暂停工作表保护才能使此方法正常工作。 如果工作表保护已启用且未暂停，则此方法将 AccessDenied 引发错误，无法设置标题。 如果已存在具有相同字符串的现有 AllowEditRange 字符串，或者该字符串 (“”) 为 null 空，则此方法将 InvalidArgument 引发错误，无法设置标题。
title: string;属性值
string
注解
方法详细信息
delete()
从 AllowEditRangeCollection中删除 对象。 必须禁用或暂停工作表保护才能使此方法正常工作。 如果启用了工作表保护但未暂停，此方法将 AccessDenied 引发错误并失败删除操作。
delete(): void;返回
void
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.AllowEditRangeLoadOptions): Excel.AllowEditRange;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.AllowEditRange;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.AllowEditRange;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
pauseProtection(password)
暂停当前会话中用户的 对象的工作表保护。 如果未启用工作表保护或已暂停，则此方法不执行任何操作。 如果工作表保护无法暂停，此方法将引发错误 UnsupportedOperation ，并且无法暂停对象的保护。 如果密码不正确，则此方法将 BadPassword 引发错误，无法暂停对 对象的保护。 如果提供了密码，但对象不需要密码，则将忽略输入的密码，并且操作将成功。
pauseProtection(password?: string): void;参数
- password
-
string
与 AllowEditRange 对象关联的密码。
返回
void
注解
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties: Interfaces.AllowEditRangeUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Excel.Interfaces.AllowEditRangeUpdateData
一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。
返回
void
set(properties)
基于现有的已加载对象，同时对对象设置多个属性。
set(properties: Excel.AllowEditRange): void;参数
- properties
- Excel.AllowEditRange
返回
void
setPassword(password)
更改与 对象关联的密码。 将密码字符串设置为空 (“”) 或 null 将从 对象中删除密码保护。 必须禁用或暂停工作表保护才能使此方法正常工作。 如果工作表保护已启用且未暂停，则此方法将 AccessDenied 引发错误，并且设置操作失败。
setPassword(password?: string): void;参数
- password
-
string
与 AllowEditRange 对象关联的密码。
返回
void
注解
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，依次调用toJSON传递给它的 对象的 方法。) 而原始 Excel.AllowEditRange 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.AllowEditRangeData) ，该对象包含从原始对象加载的任何子属性的浅表副本。
toJSON(): Excel.Interfaces.AllowEditRangeData;