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.21 的超集。

由于 API 仅受 Windows 和 Mac 上的 Excel 支持,因此ExcelApiDesktop 1.1加载项应在调用这些 API 之前检查是否支持要求集。 这可避免在不受支持的平台上使用仅桌面 API 的任何尝试。

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

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

重要

仅加载项 (XML) 清单不能将仅限桌面或仅联机的要求集指定为激活要求。 这不是在 Set 元素中使用的有效值。 统一清单支持属性中的 "requirements.capabilities" 仅桌面要求集。

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: 范围 |RangeAreas, secondRange: 范围 |RangeAreas, ...additionalRanges: (Range |RangeAreas) []) 返回RangeAreas表示两个或多个RangeRangeAreas对象的并集的对象。
windows 返回所有打开的 Excel 窗口。
CheckSpellingOptions customDictionary 可选。
ignoreUppercase 可选。
HeaderFooter centerFooterPicture 获取 HeaderFooterPicture 表示页脚中心部分图片的对象。
centerHeaderPicture 获取 HeaderFooterPicture 表示页眉中心部分图片的对象。
leftFooterPicture 获取 HeaderFooterPicture 表示页脚左侧部分图片的对象。
leftHeaderPicture 获取表示 HeaderFooterPicture 标题左侧部分图片的对象。
rightFooterPicture 获取表示 HeaderFooterPicture 页脚右侧部分图片的对象。
rightHeaderPicture 获取表示 HeaderFooterPicture 标题右侧部分图片的对象。
HeaderFooterPicture 亮度 指定图片的亮度。
colorType 指定图片的颜色转换类型。
对比度 指定图片的对比度。
cropBottom 指定从图片底部裁剪的点数。
cropLeft 指定从图片左侧裁剪的点数。
cropRight 指定从图片右侧裁剪的点数。
cropTop 指定从图片顶部裁剪的点数。
filename 指定 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?: boolean) 绘制从指定区域指向直接从属单元格的追踪箭头。
showPrecedents (remove?: boolean) 绘制从指定区域指向直接引用单元格的追踪箭头。
Window activate() 激活窗口。
activateNext () 激活下一个窗口。
activatePrevious () 激活上一个窗口。
activeCell 获取窗口中的活动单元格。
activePane 获取窗口中的活动窗格。
activeWorksheet 获取窗口中的活动工作表。
autoFilterDateGroupingEnabled 指定是否在窗口中启用自动筛选日期分组。
关闭 () 关闭窗口。
enableResize 指定是否对窗口启用调整大小。
freezePanes 指定窗口中的窗格是否冻结。
height 指定窗口的高度。
index 获取窗口的索引。
isVisible 指定窗口是否可见。
largeScroll (向下:数字,向上:数字,ToRight:数字,ToLeft:数字) 将窗口滚动多个页面。
left 指定从计算机屏幕左边缘到窗口左边缘的距离(以磅为单位)。
名称 指定窗口的名称。
newWindow () 打开一个新的 Excel 窗口。
窗格 获取与窗口关联的窗格集合。
pointsToScreenPixelsX (Points: number) 将水平点转换为屏幕像素。
pointsToScreenPixelsY (Points: number) 将垂直点转换为屏幕像素。
scrollColumn 指定窗口的滚动列。
scrollIntoView (左:数字,顶部:数字,宽度:数字,高度:数字,开始?: 布尔) 滚动窗口以将指定范围置于视图中。
scrollRow 指定窗口的滚动行。
scrollWorkbookTabs (Sheets?: number, Position?: Excel.ScrollWorkbookTabPosition) 滚动工作簿选项卡。
showFormulas 指定窗口中是否显示公式。
showGridlines 指定是否在窗口中显示网格线。
showHeadings 指定标题是否在窗口中显示。
showHorizontalScrollBar 指定是否在窗口中显示水平滚动条。
showOutline 指定窗口中是否显示大纲。
showRightToLeft 获取窗口从右到左的布局值。
showRuler 指定是否在窗口中显示标尺。
showVerticalScrollBar 指定是否在窗口中显示垂直滚动条。
showWhitespace 指定窗口中是否显示空格。
showWorkbookTabs 指定窗口中是否显示工作簿选项卡。
showZeros 指定窗口中是否显示零。
smallScroll (向下:数字,向上:数字,ToRight:数字,ToLeft:数字) 将窗口滚动行数列。
拆分 指定窗口的拆分状态。
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 () 清除指定工作表的追踪箭头。
evaluate (name: string) 返回公式字符串的计算结果。

另请参阅