Excel.AllowEditRangeCollection class

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

context: RequestContext;

属性值

获取此集合中已加载的子项。

readonly items: Excel.AllowEditRange[];

属性值

AllowEditRange将 对象添加到工作表。 必须禁用或暂停工作表保护才能使此方法正常工作。 如果工作表保护已启用且未暂停，则此方法将 AccessDenied 引发错误，并且添加作失败。

add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions): void;

参数

返回

注解

[ API 集：ExcelApiOnline 1.1 ]

返回集合中的对象数 AllowEditRange 。

getCount(): OfficeExtension.ClientResult<number>;

返回

注解

[ API 集：ExcelApiOnline 1.1 ]

AllowEditRange按标题获取对象。

getItem(key: string): Excel.AllowEditRange;

参数

返回

AllowEditRange具有标题的 。 如果给定标题没有 AllowEditRange ，则会 ItemNotFound 引发错误。

注解

[ API 集：ExcelApiOnline 1.1 ]

AllowEditRange按对象在集合中的索引返回对象。

getItemAt(index: number): Excel.AllowEditRange;

参数

返回

AllowEditRange位于给定索引处的 。

注解

[ API 集：ExcelApiOnline 1.1 ]

AllowEditRange按标题获取对象。

getItemOrNullObject(key: string): Excel.AllowEditRange;

参数

返回

AllowEditRange具有标题的 。 如果给定标题没有 AllowEditRange ，则此方法返回一个 对象，其 isNullObject 属性设置为 true。 有关详细信息，请参阅 *OrNullObject 方法和属性。

注解

[ API 集：ExcelApiOnline 1.1 ]

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

load(options?: Excel.Interfaces.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.AllowEditRangeCollection;

参数

返回

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

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

参数

返回

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.AllowEditRangeCollection;

参数

返回

暂停此工作表中找到的所有 AllowEditRange 对象的工作表保护，这些对象具有当前会话中用户的给定密码。 如果未启用工作表保护或暂停，则此方法不执行任何作。 如果工作表保护无法暂停，此方法将引发错误 UnsupportedOperation ，并且无法暂停对区域的保护。 如果密码与集合中的任何对象都不匹配 AllowEditRange ，则此方法将引发错误 BadPassword ，并且无法暂停对集合中任何范围的保护。

pauseProtection(password: string): void;

参数

返回

注解

[ API 集：ExcelApiOnline 1.1 ]

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 而原始Excel.AllowEditRangeCollection对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.AllowEditRangeCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。

toJSON(): Excel.Interfaces.AllowEditRangeCollectionData;

返回