通过

Excel JavaScript API 仅限桌面的要求集 1.1

要求ExcelApiDesktop集是一个特殊要求集，包括仅在 Excel for Windows 和 Excel for Mac 中可用的功能。 此要求集中的 API 被视为 Windows 和 Mac 上的 Excel 应用程序的生产 API。 它们遵循 Microsoft 365 开发人员支持策略。 ExcelApiDesktop API 被视为其他平台 (（如 Web 和 iPad) ）的“预览”API，并且可能不受其中任何平台的支持。

当所有平台都支持要求集中的 ExcelApiDesktop API 时，它们将添加到下一个发布的要求集 (ExcelApi 1.[NEXT]) 。 新要求集公开后，这些 API 将继续在此 ExcelApiDesktop 要求集中标记。 若要了解有关平台特定要求的详细信息，请参阅 了解特定于平台的要求集。

重要

ExcelApiDesktop 1.1 是仅限桌面的要求集。 它是 ExcelApi 1.20 的超集。

ExcelApiDesktop 1.1由于 Windows 和 Mac 上的 Excel 仅支持这些 API，因此在调用这些 API 之前，如果支持要求集，则外接程序应检查。 这可避免在不支持的平台上尝试使用仅限桌面的 API。

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

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

重要

清单不能指定 ExcelApiDesktop 1.1 为激活要求。 它不是 在 Set 元素中使用的有效值。

API 列表

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

类 域 说明
Application activeWindow 返回一个 window 对象，该对象表示活动窗口 (顶部) 窗口。
checkSpelling (word： string， options？： Excel.CheckSpellingOptions) 对单个单词进行拼写检查。
enterEditingMode () 进入活动工作表中所选区域的编辑模式。
union (firstRange： Range |RangeAreas， secondRange： Range |RangeAreas， ...additionalRanges： (范围 |RangeAreas) []) 返回一个 RangeAreas 对象，该对象代表两个或更多 Range 个 或 RangeAreas 对象的并集。
windows 返回所有打开的 Excel 窗口。
CheckSpellingOptions customDictionary 可选。
ignoreUppercase 可选。
HeaderFooter centerFooterPicture 获取一个 HeaderFooterPicture 对象，该对象表示页脚的中心部分的图片。
centerHeaderPicture 获取一个 HeaderFooterPicture 对象，该对象表示标题的中心部分的图片。
leftFooterPicture 获取一个 HeaderFooterPicture 对象，该对象代表页脚左侧部分的图片。
leftHeaderPicture 获取一个 HeaderFooterPicture 对象，该对象表示标头左侧部分的图片。
rightFooterPicture 获取一个 HeaderFooterPicture 对象，该对象代表页脚右侧部分的图片。
rightHeaderPicture 获取一个 HeaderFooterPicture 对象，该对象表示标头右侧部分的图片。
HeaderFooterPicture 亮度 指定图片的亮度。
colorType 指定图片的颜色转换类型。
反差 指定图片的对比度。
cropBottom 指定从图片底部裁剪的点数。
cropLeft 指定从图片左侧裁剪的点数。
cropRight 指定从图片右侧裁剪的点数。
cropTop 指定从图片顶部裁剪的点数。
文件名 指定 intranet 或 Web) 或路径上的 URL (， (本地或网络) 源对象的保存位置。
height 指定图片的高度（以磅为单位）。
lockAspectRatio 指定一个值，该值指示图片在调整大小时是否保留其原始比例。
width 指定图片的宽度（以磅为单位）。
图像 亮度 指定图像的亮度。
colorType 指定应用于图像的颜色转换的类型。
反差 指定图像的对比度。
cropBottom 指定从图像底部裁剪的点数。
cropLeft 指定从图像左侧裁剪的点数。
cropRight 指定从图像右侧裁剪的点数。
cropTop 指定从图像顶部裁剪的点数。
incrementBrightness (increment： number) 按指定量递增图像的亮度。
incrementContrast (increment： number) 按指定量递增图像的对比度。
PageLayout alignMarginsHeaderFooter 指定 Excel 是否将页眉和页脚与页面设置选项中设置的边距对齐。
printQuality 指定包含水平和垂直打印质量值的双元素数组。
窗格 index 返回窗格的索引。
PaneCollection getCount() 返回集合中的窗格数。
getItemAt(index: number) 按索引获取集合中的窗格。
items 获取此集合中已加载的子项。
区域 checkSpelling (选项？： Excel.CheckSpellingOptions) 检查此区域中单词的拼写。
formulaArray 指定区域的数组公式。
showDependents (remove？： 布尔) 绘制从指定区域指向直接从属单元格的追踪箭头。
showPrecedents (remove？： boolean) 绘制从指定区域指向直接引用单元格的追踪箭头。
Window activate() 激活窗口。
activateNext () 激活下一个窗口。
activatePrevious () 激活上一个窗口。
activeCell 获取窗口中的活动单元格。
activePane 获取窗口中的活动窗格。
activeWorksheet 获取窗口中的活动工作表。
autoFilterDateGroupingEnabled 指定是否在窗口中启用自动筛选日期分组。
close () 关闭窗口。
enableResize 指定是否为窗口启用大小调整。
freezePanes 指定窗格是否冻结在窗口中。
height 指定窗口的高度。
index 获取窗口的索引。
isVisible 指定窗口是否可见。
largeScroll (Down： number， Up： number， ToRight： number， ToLeft： number) 按多个页面滚动窗口。
left 指定从计算机屏幕左边缘到窗口左边缘的距离（以磅为单位）。
名称 指定窗口的名称。
newWindow () 打开新的 Excel 窗口。
窗 格 获取与窗口关联的窗格的集合。
pointsToScreenPixelsX (Points： number) 将水平点转换为屏幕像素。
pointsToScreenPixelsY (Points： number) 将垂直点转换为屏幕像素。
scrollColumn 指定窗口的滚动列。
scrollIntoView (Left： number， Top： number， Width： number， Height： number， Start？： boolean) 滚动窗口以将指定的区域置于视图中。
scrollRow 指定窗口的滚动行。
scrollWorkbookTabs (Sheets？： number， Position？： Excel.ScrollWorkbookTabPosition) 滚动工作簿选项卡。
showFormulas 指定是否在窗口中显示公式。
showGridlines 指定是否在窗口中显示网格线。
showHeadings 指定标题是否显示在窗口中。
showHorizontalScrollBar 指定是否在窗口中显示水平滚动条。
showOutline 指定是否在窗口中显示轮廓。
showRightToLeft 获取窗口的从右到左布局值。
showRuler 指定是否在窗口中显示标尺。
showVerticalScrollBar 指定是否在窗口中显示垂直滚动条。
showWhitespace 指定是否在窗口中显示空格。
showWorkbookTabs 指定是否在窗口中显示工作簿选项卡。
showZeros 指定是否在窗口中显示零。
smallScroll (Down： number， Up： number， ToRight： number， ToLeft： number) 按多个行或列滚动窗口。
分裂 指定窗口的拆分状态。
splitColumn 指定窗口的拆分列。
splitHorizontal 指定窗口的水平拆分。
splitRow 指定窗口的拆分行。
splitVertical 指定窗口的垂直拆分。
tabRatio 指定窗口的制表符比率。
top 指定从窗口的上边缘到可用区域上边缘的距离（以磅为单位）， (菜单下方、停靠在顶部的任何工具栏以及编辑栏) 。
type 指定窗口的类型。
usableHeight 获取窗口的可用高度。
usableWidth 获取窗口的可用宽度。
view 指定窗口的视图。
visibleRange 获取窗口的可见范围。
width 指定窗口的显示宽度。
windowNumber 获取窗口编号。
windowState 指定窗口状态。
zoom 指定表示窗口的显示大小的整数值。
WindowCollection breakSideBySide () 中断窗口的并排视图。
compareCurrentSideBySideWith (windowName： string) 将当前窗口与指定窗口并排进行比较。
getCount() 获取集合中的窗口数。
getItemAt(index: number) 按索引获取集合中的窗口。
items 获取此集合中已加载的子项。
resetPositionsSideBySide () 重置并排视图中窗口的位置。
Workbook 焦点 () 将焦点设置为工作簿。
Worksheet checkSpelling (选项？： Excel.CheckSpellingOptions) 检查此工作表中单词的拼写。
clearArrows () 清除指定工作表的追踪箭头。
评估 (名称：字符串) 返回公式字符串的计算结果。

另请参阅