Excel JavaScript API 仅联机要求集

ExcelApiOnline要求集是一个特殊要求集，其中包括仅适用于 Excel web 版的功能。 此要求集中的 API 被视为生产 API， (不受 Excel web 版 应用程序) 的未记录的行为或结构更改的影响。 ExcelApiOnline API 被视为适用于其他平台 (Windows、Mac、iOS) 的“预览版”API，这些平台可能都不受支持。

当所有平台都支持要求集中的 ExcelApiOnline API 时，它们将添加到) (ExcelApi 1.[NEXT] 下一个发布的要求集中。 公开新要求集后，这些 API 将从 ExcelApiOnline中删除。 将此视为类似于 API 从预览版移动到发布的推广过程。

重要

ExcelApiOnline 是最新编号要求集的超集。

重要

ExcelApiOnline 1.1 是仅联机 API 的唯一版本。 这是因为 Excel web 版将始终有一个最新版本可供用户使用，即最新版本。

下表简明扼要地介绍了 API，而后续 API 列表 表则提供了当前 ExcelApiOnline API 的详细列表。

功能区域 说明 相关对象
链接的工作簿个数 管理工作簿之间的链接，包括支持刷新和断开工作簿链接。 LinkedWorkbook、 LinkedWorkbookCollection
命名工作表视图 可对每用户工作表视图进行编程控制。 NamedSheetView、 NamedSheetViewCollection
工作表移动事件 检测集合中工作表的移动时间、工作表的位置以及更改的来源。 WorksheetCollection、 WorksheetMovedEventArgs
工作表保护 防止未经授权的用户对工作表中的指定范围进行更改。 WorksheetProtection、 AllowEditRange、 AllowEditRangeCollection、 AllowEditRangeOptions

由于 API 仅受 Excel web 版支持，因此ExcelApiOnline在调用这些 API 之前，加载项应检查是否支持要求集。 这会避免在其他平台上调用仅联机 API。

if (Office.context.requirements.isSetSupported("ExcelApiOnline", "1.1")) {
   // Any API exclusive to the ExcelApiOnline requirement set.
}

API 处于跨平台要求集中后，应移除或编辑isSetSupported检查。 这将在其他平台上启用加载项的功能。 进行此更改时，请务必在这些平台上测试该功能。

重要

您的清单无法指定 ExcelApiOnline 1.1 为激活要求。 这不是在 Set 元素中使用的有效值。

API 列表

下表列出了当前包含在要求集中的 ExcelApiOnline Excel JavaScript API。 有关所有 Excel JavaScript API 的完整列表 (ExcelApiOnline 包括 API 和以前发布的 API) ，请参阅 所有 Excel JavaScript API。

类 域 说明
AllowEditRange address 指定与对象关联的范围。
delete() 从文件夹中 AllowEditRangeCollection删除对象。
isPasswordProtected 指定对象是否受密码保护。
pauseProtection (password？： string) 暂停当前会话中用户的对象工作表保护。
setPassword (password？： string) 更改与对象关联的密码。
title 指定对象的标题。
AllowEditRangeCollection add (title： string， rangeAddress： string， options？： Excel.AllowEditRangeOptions) 向工作表添加 AllowEditRange 对象。
getCount() 返回集合中的对象数 AllowEditRange 。
getItem(key: string) 按对象标题获取 AllowEditRange 对象。
getItemAt(index: number) 按对象在集合中的索引返回 AllowEditRange 对象。
getItemOrNullObject(key: string) 按对象标题获取 AllowEditRange 对象。
items 获取此集合中已加载的子项。
pauseProtection (密码： 字符串) 暂停对此工作表中找到的 AllowEditRange 具有当前会话中用户指定密码的所有对象的工作表保护。
AllowEditRangeOptions password 与 相关联的 AllowEditRange密码。
LinkedWorkbook breakLinks () 发出断开指向链接工作簿的链接的请求。
id 指向链接工作簿的原始 URL。
refresh() 发出请求以刷新从链接工作簿检索到的数据。
LinkedWorkbookCollection breakAllLinks () 断开指向链接工作簿的所有链接。
getItem(key: string) 按链接工作簿的 URL 获取有关链接工作簿的信息。
getItemOrNullObject(key: string) 按链接工作簿的 URL 获取有关链接工作簿的信息。
items 获取此集合中已加载的子项。
refreshAll () 请求刷新所有工作簿链接。
workbookLinksRefreshMode 表示工作簿链接的更新模式。
NamedSheetView activate() 激活此工作表视图。
delete() 从工作表中删除工作表视图。
duplicate (name？： string) 创建此工作表视图的副本。
名称 指定图纸视图的名称。
NamedSheetViewCollection add(name: string) 创建具有给定名称的新图纸视图。
enterTemporary () 创建并激活新的临时图纸视图。
退出 () 退出当前活动的工作表视图。
getActive () 获取工作表的当前活动工作表视图。
getCount() 获取此工作表中工作表视图的数目。
getItem(key: string) 使用工作表名称获取工作表视图。
getItemAt(index: number) 按集合中的索引获取工作表视图。
items 获取此集合中已加载的子项。
TableRowCollection deleteRows (rows： number[] |TableRow[]) 删除表中的多行。
deleteRowsAt (index： number， count？： number) 从表中删除指定数量的行，从给定索引开始。
Workbook linkedWorkbooks 返回链接工作簿的集合。
Worksheet namedSheetViews 返回工作表中存在的工作表视图集合。
WorksheetProtection allowEditRanges 指定在此工作表中找到的 AllowEditRangeCollection 对象。
canPauseProtection 指定是否可以暂停对此工作表的保护。
checkPassword (password？： string) 指定是否可以使用密码解锁工作表保护。
isPasswordProtected 指定工作表是否受密码保护。
isPaused 指定是否暂停工作表保护。
pauseProtection (password？： string) 为当前会话中的用户暂停给定工作表对象的工作表保护。
resumeProtection () 在给定会话中为给定工作表对象恢复给定工作表对象的工作表保护。
savedOptions 指定工作表中保存的保护选项。
setPassword (password？： string) 更改与对象关联的 WorksheetProtection 密码。
updateOptions (选项：Excel.WorksheetProtectionOptions) 更改与 WorksheetProtection 对象关联的工作表保护选项。
WorksheetProtectionChangedEventArgs allowEditRangesChanged 指定是否有任何 AllowEditRange 对象已更改。
protectionOptionsChanged 指定是否 WorksheetProtectionOptions 已更改。
sheetPasswordChanged 指定工作表密码是否已更改。

另请参阅

  • Last updated on