Excel JavaScript API 仅联机要求集

  • 项目

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

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

重要

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

重要

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

下表提供了 API 的简明摘要，而后续 API 列表 表提供了当前 ExcelApiOnline API 的详细列表。

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

由于 ExcelApiOnline API 仅受Excel web 版支持，因此，如果支持要求集，则外接程序应在调用这些 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 (密码：string) 暂停此工作表中找到的所有 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() 从工作表中删除工作表视图。
重复 (名称？： 字符串) 创建此工作表视图的副本。
名称 获取或设置工作表视图的名称。
NamedSheetViewCollection add(name: string) 创建具有给定名称的新工作表视图。
enterTemporary () 创建并激活新的临时工作表视图。
exit () 退出当前活动的工作表视图。
getActive () 获取工作表的当前活动工作表视图。
getCount() 获取此工作表中的工作表视图数。
getItem(key: string) 使用其名称获取工作表视图。
getItemAt(index: number) 按其集合中的索引获取工作表视图。
items 获取此集合中已加载的子项。
TableRowCollection deleteRows (行： number[] |TableRow[]) 从表中删除多个行。
deleteRowsAt (index： number， count？： number) 从表中删除指定数量的行，从给定索引处开始。
Workbook linkedWorkbooks 返回链接工作簿的集合。
Worksheet namedSheetViews 返回工作表中存在的工作表视图的集合。
WorksheetProtection allowEditRanges 指定 AllowEditRangeCollection 在此工作表中找到的对象。
canPauseProtection 指定是否可以暂停此工作表的保护。
checkPassword (password？： string) 指定密码是否可用于解锁工作表保护。
isPasswordProtected 指定工作表是否受密码保护。
isPaused 指定工作表保护是否暂停。
pauseProtection (password？： string) 暂停当前会话中用户的给定工作表对象的工作表保护。
resumeProtection () 为给定会话中的用户恢复给定 worksheet 对象的工作表保护。
savedOptions 指定工作表中保存的保护选项。
setPassword (password？： string) 更改与 WorksheetProtection 对象关联的密码。
updateOptions (选项：Excel.WorksheetProtectionOptions) 更改与 对象关联的 WorksheetProtection 工作表保护选项。
WorksheetProtectionChangedEventArgs allowEditRangesChanged 指定是否更改了任何 AllowEditRange 对象。
protectionOptionsChanged 指定 是否已 WorksheetProtectionOptions 更改。
sheetPasswordChanged 指定工作表密码是否已更改。

另请参阅