Excel.AllowEditRange class

包:

excel

表示在工作表中找到的 AllowEditRange 对象。 此对象与工作表保护属性一起工作。 启用工作表保护后， AllowEditRange 可以使用对象允许编辑特定范围，同时保持对工作表其余部分的保护。

扩展

OfficeExtension.ClientObject

注解

API 集：ExcelApiOnline 1.1

使用方

• Excel.AllowEditRangeCollection： getItem， getItemAt， getItemOrNullObject， items

属性

address	指定与对象关联的范围。 必须禁用或暂停工作表保护，此方法才能正常工作。 如果启用工作表保护且未暂停，则此方法会引发错误 AccessDenied ，并且无法设置范围。
context	与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。
isPasswordProtected	指定对象是否受密码保护。
title	指定对象的标题。 必须禁用或暂停工作表保护，此方法才能正常工作。 如果启用工作表保护且未暂停，则此方法会引发错误 AccessDenied 并无法设置标题。 如果已经存在具有相同字符串的字符串 AllowEditRange ，或者字符串为 null 空 (“”) ，则此方法会引发 InvalidArgument 错误并且无法设置标题。

方法

delete()	从文件夹中 AllowEditRangeCollection删除对象。 必须禁用或暂停工作表保护，此方法才能正常工作。 如果工作表保护已启用且未暂停，则此方法会 AccessDenied 引发错误并使删除操作失败。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
pauseProtection(password)	暂停当前会话中用户的对象工作表保护。 如果未启用或已暂停工作表保护，则此方法不执行任何操作。 如果无法暂停工作表保护，则此方法将 UnsupportedOperation 引发错误，并且无法暂停针对该对象的保护。 如果密码不正确，则此方法会引发错误 BadPassword ，并且无法暂停对对象的保护。 如果提供了密码，但对象不需要密码，则输入的密码将被忽略，操作将成功。
set(properties, options)	同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties)	基于现有加载的对象，同时在对象上设置多个属性。
setPassword(password)	更改与对象关联的密码。 将密码字符串设置为空 (“”) 将 null 从对象中删除密码保护。 必须禁用或暂停工作表保护，此方法才能正常工作。 如果启用工作表保护且未暂停，则此方法会引发错误 AccessDenied ，并且设置操作失败。
toJSON()	覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.AllowEditRange 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.AllowEditRangeData) ，其中包含从原始对象加载的任何子属性的浅层副本。

属性详细信息

address

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

address: string;

属性值

string

注解

API 集：ExcelApiOnline 1.1

context

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

context: RequestContext;

属性值

Excel.RequestContext

isPasswordProtected

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

readonly isPasswordProtected: boolean;

属性值

boolean

注解

API 集：ExcelApiOnline 1.1

title

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

title: string;

属性值

string

注解

API 集：ExcelApiOnline 1.1

方法详细信息

delete()

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

delete(): void;

返回

void

注解

API 集：ExcelApiOnline 1.1

load(options)

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

load(options?: Excel.Interfaces.AllowEditRangeLoadOptions): Excel.AllowEditRange;

参数

options

Excel.Interfaces.AllowEditRangeLoadOptions

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

返回

Excel.AllowEditRange

load(propertyNames)

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

load(propertyNames?: string | string[]): Excel.AllowEditRange;

参数

propertyNames

string | string[]

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

返回

Excel.AllowEditRange

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.AllowEditRange;

参数

propertyNamesAndPaths

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

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

返回

Excel.AllowEditRange

pauseProtection(password)

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

pauseProtection(password?: string): void;

参数

password

string

与对象关联的 AllowEditRange 密码。

返回

void

注解

API 集：ExcelApiOnline 1.1

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

注解

API 集：ExcelApiOnline 1.1

toJSON()

覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.AllowEditRange 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.AllowEditRangeData) ，其中包含从原始对象加载的任何子属性的浅层副本。

toJSON(): Excel.Interfaces.AllowEditRangeData;

返回

Excel.Interfaces.AllowEditRangeData