ExcelScript.AllowEditRange interface

包:

ExcelScript

表示 AllowEditRange 在工作表中找到的对象。 此对象适用于工作表保护属性。 启用工作表保护后， AllowEditRange 可以使用 对象来允许编辑特定区域，同时对工作表的其余部分保持保护。

方法

delete()	从 AllowEditRangeCollection中删除 对象。 必须禁用或暂停工作表保护才能使此方法正常工作。 如果启用了工作表保护但未暂停，此方法将 AccessDenied 引发错误并失败删除操作。
getAddress()	指定与 对象关联的范围。
getIsPasswordProtected()	指定对象是否受密码保护。
getTitle()	指定 对象的标题。
pauseProtection(password)	暂停当前会话中用户的 对象的工作表保护。 如果未启用工作表保护或已暂停，则此方法不执行任何操作。 如果工作表保护无法暂停，此方法将引发错误 UnsupportedOperation ，并且无法暂停对象的保护。 如果密码不正确，则此方法将 BadPassword 引发错误，无法暂停对 对象的保护。 如果提供了密码，但对象不需要密码，则将忽略输入的密码，并且操作将成功。
setAddress(address)	指定与 对象关联的范围。 必须禁用或暂停工作表保护才能使此方法正常工作。 如果启用了工作表保护但未暂停，则此方法将 AccessDenied 引发错误，并且无法设置范围。
setPassword(password)	更改与 对象关联的密码。 将密码字符串设置为空 (“”) 或 null 将从 对象中删除密码保护。 必须禁用或暂停工作表保护才能使此方法正常工作。 如果工作表保护已启用且未暂停，则此方法将 AccessDenied 引发错误，并且设置操作失败。
setTitle(title)	指定 对象的标题。 必须禁用或暂停工作表保护才能使此方法正常工作。 如果工作表保护已启用且未暂停，则此方法将 AccessDenied 引发错误，无法设置标题。 如果已存在具有相同字符串的现有 AllowEditRange 字符串，或者该字符串 (“”) 为 null 空，则此方法将 InvalidArgument 引发错误，无法设置标题。

方法详细信息

delete()

从 AllowEditRangeCollection中删除 对象。 必须禁用或暂停工作表保护才能使此方法正常工作。 如果启用了工作表保护但未暂停，此方法将 AccessDenied 引发错误并失败删除操作。

delete(): void;

返回

void

getAddress()

指定与 对象关联的范围。

getAddress(): string;

返回

string

getIsPasswordProtected()

指定对象是否受密码保护。

getIsPasswordProtected(): boolean;

返回

boolean

getTitle()

指定 对象的标题。

getTitle(): string;

返回

string

pauseProtection(password)

暂停当前会话中用户的 对象的工作表保护。 如果未启用工作表保护或已暂停，则此方法不执行任何操作。 如果工作表保护无法暂停，此方法将引发错误 UnsupportedOperation ，并且无法暂停对象的保护。 如果密码不正确，则此方法将 BadPassword 引发错误，无法暂停对 对象的保护。 如果提供了密码，但对象不需要密码，则将忽略输入的密码，并且操作将成功。

pauseProtection(password?: string): void;

参数

password

string

与 AllowEditRange 对象关联的密码。

返回

void

setAddress(address)

指定与 对象关联的范围。 必须禁用或暂停工作表保护才能使此方法正常工作。 如果启用了工作表保护但未暂停，则此方法将 AccessDenied 引发错误，并且无法设置范围。

setAddress(address: string): void;

参数

address

string

返回

void

setPassword(password)

更改与 对象关联的密码。 将密码字符串设置为空 (“”) 或 null 将从 对象中删除密码保护。 必须禁用或暂停工作表保护才能使此方法正常工作。 如果工作表保护已启用且未暂停，则此方法将 AccessDenied 引发错误，并且设置操作失败。

setPassword(password?: string): void;

参数

password

string

与 AllowEditRange 对象关联的密码。

返回

void

setTitle(title)

指定 对象的标题。 必须禁用或暂停工作表保护才能使此方法正常工作。 如果工作表保护已启用且未暂停，则此方法将 AccessDenied 引发错误，无法设置标题。 如果已存在具有相同字符串的现有 AllowEditRange 字符串，或者该字符串 (“”) 为 null 空，则此方法将 InvalidArgument 引发错误，无法设置标题。

setTitle(title: string): void;

参数

title

string

返回

void