Excel.AllowEditRangeCollection class
表示在工作表中找到的 AllowEditRange 对象集。
AllowEditRange 对象使用工作表保护属性。 启用工作表保护后， AllowEditRange 可以使用对象允许编辑特定范围，同时保持对工作表其余部分的保护。
方法
| add(title, range |
向工作表添加 |
| get |
返回集合中的对象数 |
| get |
按对象标题获取 |
| get |
按对象在集合中的索引返回 |
| get |
按对象标题获取 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| pause |
暂停对此工作表中找到的 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
context
items
方法详细信息
add(title, rangeAddress, options)
向工作表添加 AllowEditRange 对象。 必须禁用或暂停工作表保护，此方法才能正常工作。 如果启用工作表保护且未暂停，则此方法会引发错误 AccessDenied ，并且添加操作失败。
add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions): void;参数
- title
-
string
要添加的 AllowEditRange 对象的标题字符串。
- rangeAddress
-
string
要添加的 AllowEditRange 对象的范围地址。
- options
- Excel.AllowEditRangeOptions
要添加到对象的其他 AllowEditRange 选项，例如密码。
返回
void
注解
getCount()
返回集合中的对象数 AllowEditRange 。
getCount(): OfficeExtension.ClientResult<number>;返回
OfficeExtension.ClientResult<number>
注解
getItem(key)
按对象标题获取 AllowEditRange 对象。
getItem(key: string): Excel.AllowEditRange;参数
- key
-
string
的 AllowEditRange标题。
返回
与 AllowEditRange 标题一起。 如果给定游戏没有， AllowEditRange 则 ItemNotFound 会引发错误。
注解
getItemAt(index)
按对象在集合中的索引返回 AllowEditRange 对象。
getItemAt(index: number): Excel.AllowEditRange;参数
- index
-
number
集合中对象的 AllowEditRange 索引。
返回
给定索引处的 。AllowEditRange
注解
getItemOrNullObject(key)
按对象标题获取 AllowEditRange 对象。
getItemOrNullObject(key: string): Excel.AllowEditRange;参数
- key
-
string
的 AllowEditRange标题。
返回
与 AllowEditRange 标题一起。 如果给定的标题没有， AllowEditRange 则此方法返回其 isNullObject 属性设置为 true的对象。 有关详细信息，请参阅 *OrNullObject 方法和属性。
注解
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.AllowEditRangeCollection;参数
- options
-
Excel.Interfaces.AllowEditRangeCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.AllowEditRangeCollection;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.AllowEditRangeCollection;参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
pauseProtection(password)
暂停对此工作表中找到的 AllowEditRange 具有当前会话中用户指定密码的所有对象的工作表保护。 如果未启用或暂停工作表保护，则此方法不执行任何操作。 如果无法暂停工作表保护，则此方法将引发错误 UnsupportedOperation ，并且无法暂停针对该范围的保护。 如果密码与集合中的任何 AllowEditRange 对象都不匹配，则此方法将 BadPassword 引发错误，并且无法暂停对集合中任何范围的保护。
pauseProtection(password: string): void;参数
- password
-
string
用于暂停对象保护 AllowEditRange 的密码。
返回
void
注解
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.AllowEditRangeCollection 对象是 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.AllowEditRangeCollectionData) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。
toJSON(): Excel.Interfaces.AllowEditRangeCollectionData;