Excel.AllowEditRangeCollection class
表示在工作表中找到的对象 AllowEditRange 集。
AllowEditRange 对象使用工作表保护属性。 启用工作表保护后， AllowEditRange 可以使用 对象来允许编辑特定区域，同时对工作表的其余部分保持保护。
- 扩展
注解
属性
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| items | 获取此集合中已加载的子项。 |
方法
| 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”数组，其中包含集合项中任何已加载属性的浅表副本。
toJSON(): Excel.Interfaces.AllowEditRangeCollectionData;