API总览

API

分类

表格实例(Application)

属性	数据类型	简介
[ActiveSheet](/api/excel/workbook/Application#activesheet)	[Sheet](/api/excel/workbook/Sheet)	当前的活动工作表
[Sheets](/api/excel/workbook/Application#sheets)	[Sheets](/api/excel/workbook/Application#sheets)	当前文件的所有工作表
[ActiveWorkbook](/api/excel/workbook/Application#activeworkbook)	[Workbook](/api/excel/workbook/Workbook)	当前的文档
[Selection](/api/excel/workbook/Application#selection)	[Range](/api/excel/workbook/Range)	当前的选区对象
[Cells](/api/excel/workbook/Application#cells)	[Range](/api/excel/workbook/Range)	当前工作表所有单元格
[Columns](/api/excel/workbook/Application#columns)	[Range](/api/excel/workbook/Range)	当前工作表所有列
[Rows](/api/excel/workbook/Application#rows)	[Range](/api/excel/workbook/Range)	当前工作表所有行
[FileInfo](/api/excel/workbook/Application#fileinfo)	Object	当前文档的信息
[UserInfo](/api/excel/workbook/Application#userinfo)	Object	当前文档的用户信息
[Enum](/api/excel/workbook/Application#enum)	[Enum](/api/excel/workbook/Enum)	所有的枚举类型

方法	返回类型	简介
[Range(address)](/api/excel/workbook/Application#range)	[Range](/api/excel/workbook/Range)	获取当前 ActiveSheet 的某个区域(address 指定)
[Sheets(name)](/api/excel/workbook/Application#sheets-1)	[Sheet](/api/excel/workbook/Sheet)	获取名称为 name 的工作表

工作簿(Workbook)

属性	数据类型	简介
[ActiveSheet](/api/excel/workbook/Workbook#activesheet)	[Sheet](/api/excel/workbook/Sheet)	工作簿中的活动工作表
[Sheets](/api/excel/workbook/Workbook#sheets)	[Sheets](/api/excel/workbook/Application#sheets)	工作表的所有对象集合
[ReadOnly](/api/excel/workbook/Workbook#readonly)	Boolean	文档是否只读
[ReadOnlyComment](/api/excel/workbook/Workbook#readonlycomment)	Boolean	文档是否只读可评论的权限
[SupportReadOnlyComment](/api/excel/workbook/Workbook#supportreadonlycomment)	Boolean	文档是否支持只读可评论权限

方法	返回类型	简介
[Save()](/api/excel/workbook/Workbook#save)	String(JSON)	保存文件的改动
[GetComments()](/api/excel/workbook/Workbook#getcomments)	String(JSON)	获取整个 Workbook 的评论
[ExportAsFixedFormat()](/api/excel/workbook/Workbook#exportasfixedformat)	String(JSON)	导出整个表格的 PDF 或者 Img 图片

工作表(Sheet)

属性	数据类型	简介
[Id](/api/excel/workbook/Sheet#id)	String	该工作表的 Id
[Name](/api/excel/workbook/Sheet#name)	String	该工作表的名称
[Index](/api/excel/workbook/Sheet#index)	Number	该工作表在所有工作表的索引值
[Cells](/api/excel/workbook/Sheet#cells)	[Range](/api/excel/workbook/Range)	该工作表上所有单元格的集合
[Columns](/api/excel/workbook/Sheet#columns)	[Range](/api/excel/workbook/Range)	该工作表上所有列的集合
[Rows](/api/excel/workbook/Sheet#rows)	[Range](/api/excel/workbook/Range)	该工作表上所有行的集合
[UsedRange](/api/excel/workbook/Sheet#usedrange)	[Range](/api/excel/workbook/Range)	该工作表的使用范围
[Visible](/api/excel/workbook/Sheet#visible)	Boolean	该工作表是否可见
[Type](/api/excel/workbook/Sheet#type)	String	该工作表的类型
[Hyperlinks](/api/excel/workbook/Sheet#hyperlinks)	[Hyperlinks](/api/excel/workbook/Sheet#hyperlinks)	该工作表上所有超链接的集合
[Shapes](/api/excel/workbook/Sheet#shapes)	[Shapes](/api/excel/workbook/Sheet#shapes)	该工作表上所有图形的集合
[Sort](/api/excel/workbook/Sheet#sort)	[Sort](/api/excel/workbook/Sheet#/api/excel/workbook/Sort)	该工作表上排序对象

方法	返回类型	简介
[Range()](/api/excel/workbook/Sheet#range)	[Range](/api/excel/workbook/Range)	一个单元格或单元格区域
[Cells()](/api/excel/workbook/Sheet#cells-1)	[Range](/api/excel/workbook/Range)	该工作表上的某个单元格
[Activate()](/api/excel/workbook/Sheet#activate)	undefined	切换(激活)工作表
[Move()](/api/excel/workbook/Sheet#move)	undefined	移动工作表
[Delete()](/api/excel/workbook/Sheet#delete)	undefined	删除工作表

区域(Range)

属性	数据类型	简介
[Count](/api/excel/workbook/Range#count)	Number	区域中单元格的数量
[Text](/api/excel/workbook/Range#text)	String	【只读】读取单元格格式化文本
[Value/Value2](/api/excel/workbook/Range#value)	any/[][]any	读写单元格中的值
[FormatConditions](/api/excel/workbook/Range#formatConditions)	[FormatConditions](/api/excel/workbook/FormatConditions)	用于控制 Excel 中的条件格式
[Formula](/api/excel/workbook/Range#formula)	String	以 A1 样式表示法表示的对象的隐式交叉的公式
[FormulaArray](/api/excel/workbook/Range#formulaarray)	String	返回或设置区域的数组公式
[NumberFormat](/api/excel/workbook/Range#numberformat)	String	获取或者设置区域的数字格式
[Hidden](/api/excel/workbook/Range#hidden)	Boolean	行或者列的隐藏
[Interior.Color](/api/excel/workbook/Range#interior-color)	String	内部颜色的十六进制 RGB
[HorizontalAlignment](/api/excel/workbook/Range#horizontalalignment)	[Enum.XlHAlign](/api/excel/workbook/Enum#xlhalign)	设置区域的水平对齐方式
[VerticalAlignment](/api/excel/workbook/Range#verticalalignment)	[Enum.XlVAlign](/api/excel/workbook/Enum#xlvalign)	设置区域的垂直对齐方式
[WrapText](/api/excel/workbook/Range#wraptext)	Boolean	获取或者设置区域自动换行
[IndentLevel](/api/excel/workbook/Range#indentlevel)	Number	单元格缩进
[MergeArea](/api/excel/workbook/Range#mergearea)	[Range](/api/excel/workbook/Range)	单元格的合并区域
[MergeCells](/api/excel/workbook/Range#mergecells)	Boolean	区域内是否存在合并的单元格
[Cells](/api/excel/workbook/Range#cells)	[Range](/api/excel/workbook/Range)	区域中的单元格集合
[Rows](/api/excel/workbook/Range#rows)	[Range](/api/excel/workbook/Range)	区域中的行集合
[Columns](/api/excel/workbook/Range#columns)	[Range](/api/excel/workbook/Range)	区域中的列集合
[EntireRow](/api/excel/workbook/Range#entirerow)	[Range](/api/excel/workbook/Range)	区域所在行的整行
[EntireColumn](/api/excel/workbook/Range#entirecolumn)	[Range](/api/excel/workbook/Range)	区域所在列的整列
[Row](/api/excel/workbook/Range#row)	Number	区域中第一行的行号
[RowEnd](/api/excel/workbook/Range#rowend)	Number	区域中最后一行的行号
[Column](/api/excel/workbook/Range#column)	Number	区域中第一列的列号
[ColumnEnd](/api/excel/workbook/Range#columnend)	Number	区域中最后一列的列号
[Borders](/api/excel/workbook/Range#borders)	[Borders](/api/excel/workbook/Range#borders)	边框集合对象

方法	返回类型	简介
[BorderAround()](/api/excel/workbook/Range#borderaround)	undefined	向区域添加边框，并为新边框设置 Border 对象的 Color、LineStyle 和 Weight 属性
[Each()](/api/excel/workbook/Range#each)	undefined	遍历选区所选单元格
[Item()](/api/excel/workbook/Range#item)	[Range](/api/excel/workbook/Range)	表示区域中指定的位置
[Offset()](/api/excel/workbook/Range#offset)	undefined	对指定区域进行迁移操作
[Replace()](/api/excel/workbook/Range#replace)	undefined	对单元格内文本执行替换操作
[Delete()](/api/excel/workbook/Range#delete)	undefined	单元格、行、列的删除
[Insert()](/api/excel/workbook/Range#insert)	undefined	单元格、行、列的新增
[InsertImage()](/api/excel/workbook/Range#insertimage)	undefined	插入单元格图片
[Merge()](/api/excel/workbook/Range#merge)	undefined	合并单元格
[UnMerge()](/api/excel/workbook/Range#unmerge)	undefined	取消合并单元格
[Address()](/api/excel/workbook/Range#address)	String	获取表示使用宏语言的区域引用的 String 值
[AddComment()](/api/excel/workbook/Range#addcomment)	undefined	添加评论
[ClearComments()](/api/excel/workbook/Range#clearcomments)	undefined	清除区域的评论
[Clear()](/api/excel/workbook/Range#clear)	undefined	清空指定区域数据和样式
[ClearContents()](/api/excel/workbook/Range#clearcontents)	undefined	清除区域的内容
[ClearFormats()](/api/excel/workbook/Range#clearformats)	undefined	清除区域的样式
[ClearHyperlinks()](/api/excel/workbook/Range#clearhyperlinks)	undefined	清除区域的超链接样式
[Contain()](/api/excel/workbook/Range#contain)	Boolean	判断区域是否重叠
[Copy()](/api/excel/workbook/Range#copy)	Boolean	将当前区域对象复制到剪贴板
[Cut()](/api/excel/workbook/Range#cut)	Boolean	将当前区域对象粘贴到目标区域
[PasteSpecial()](/api/excel/workbook/Range#pastespecial)	undefined	将剪贴板中的内容粘贴到指定的单元格或范围
[FillLeft()](/api/excel/workbook/Range#fillleft)	undefined	对指定区域中的单元格执行从右往左填充
[FillRight()](/api/excel/workbook/Range#fillright)	undefined	对指定区域中的单元格执行从左往右填充
[FillDown()](/api/excel/workbook/Range#filldown)	undefined	对指定区域中的单元格执行从上往下填充
[FillUp()](/api/excel/workbook/Range#fillup)	undefined	对指定区域中的单元格执行从下往上填充
[AutoFill()](/api/excel/workbook/Range#autofill)	undefined	对指定区域中的单元格执行自动填充
[AutoFilter()](/api/excel/workbook/Range#autofilter)	undefined	对指定区域中的单元格执行自动筛选
[AutoFit()](/api/excel/workbook/Range#autofit)	undefined	更改区域中的列宽或行高以达到最佳匹配
[Select()](/api/excel/workbook/Range#select)	undefined	选择区域
[TextToColumns()](/api/excel/workbook/Range#texttocolumns)	undefined	将包含文本的一列单元格分解为若干列

筛选(AutoFilter)

属性	数据类型	简介
[Filters](/api/excel/workbook/AutoFilter#filters)	[Filters](/api/excel/workbook/AutoFilter#filters)	筛选对象集合
[Range](/api/excel/workbook/AutoFilter#range)	[Range](/api/excel/workbook/Range)	筛选区域

方法	返回类型	简介
[ApplyFilter()](/api/excel/workbook/AutoFilter#applyfilter)	undefined	应用筛选到当前工作表
[ShowAllData()](/api/excel/workbook/AutoFilter#showalldata)	undefined	清除所有筛选条件，显示所有数据

排序(Sort)

属性	数据类型	简介
[Header](/api/excel/workbook/Sort#header)	[XlYesNoGuess](/api/excel/workbook/Enum#xlyesnoguess)	指定第一行是否包含标题信息
[MatchCase](/api/excel/workbook/Sort#matchcase)	Boolean	是否区分大小写
[Orientation](/api/excel/workbook/Sort#orientation)	[XlSortOrientation](/api/excel/workbook/Enum#xlsortorientation)	指定排序方向
[Rng](/api/excel/workbook/Sort#rng)	[Range](/api/excel/workbook/Range)	返回要执行排序的值的区域
[SortFields](/api/excel/workbook/Sort#sortfields)	[SortFields](/api/excel/workbook/SortFields)	该对象代表与 **Sort** 对象关联的排序字段的集合
[SortMethod](/api/excel/workbook/Sort#sortmethod)	[XlSortMethod](/api/excel/workbook/Enum#xlsortmethod)	中文排序方法

方法	返回类型	简介
[Apply()](/api/excel/workbook/Sort#apply)	undefined	根据当前应用的排序状态对区域进行排序
[SetRange()](/api/excel/workbook/Sort#setrange)	undefined	设置排序发生的范围

排序字段(SortField)

代表与 **Sort** 对象关联的排序字段对象

属性	数据类型	简介
[CustomOrder](/api/excel/workbook/SortField#customorder)	Variant	指定对字段进行排序的自定义次序
[DataOption](/api/excel/workbook/SortField#dataoption)	[XlSortDataOption](/api/excel/workbook/Enum#xlsortdataoption)	指定如何在 SortField 对象中指定的区域中对文本进行排序
[Key](/api/excel/workbook/SortField#key)	[Range](/api/excel/workbook/Range)	指定排序字段，该字段确定要排序的值
[Order](/api/excel/workbook/SortField#order)	[XlSortOrder](/api/excel/workbook/Enum#xlsortorder)	确定关键字所指定的值的排序次序
[Priority](/api/excel/workbook/SortField#priority)	Number	指定排序字段的优先级
[SortOn](/api/excel/workbook/SortField#sorton)	[XlSortOn](/api/excel/workbook/Enum#xlsorton)	返回或设置要排序的单元格的属性
[SortOnValue](/api/excel/workbook/SortField#sortonvalue)	Object	返回针对指定的 SortField 对象执行排序的值

方法	返回类型	简介
[Delete()](/api/excel/workbook/SortField#delete)	undefined	从 SortFields 集合中删除指定的 SortField 对象
[ModifyKey()](/api/excel/workbook/SortField#modifykey)	undefined	修改字段中按其排序的键值

字体(Font)

单元格内字体的属性，包括加粗，颜色，大小，斜体，删除线和下划线。

属性	数据类型	简介
[Bold](/api/excel/workbook/Font#bold)	Boolean	字体是否加粗
[Color](/api/excel/workbook/Font#color)	String	字体的颜色
[Italic](/api/excel/workbook/Font#italic)	Boolean	字体是否斜体
[Name](/api/excel/workbook/Font#name)	String	字体的名称
[Size](/api/excel/workbook/Font#size)	Number	字体的大小
[Strikethrough](/api/excel/workbook/Font#strikethrough)	Boolean	字体是否有删除线
[Underline](/api/excel/workbook/Font#underline)	[Enum.XlUnderlineStyle](/api/excel/workbook/Enum#xlunderlinestyle)	字体是否有下划线

边框(Border)

边框对象，Borders 集合里的某一边框

属性	数据类型	简介
[Color](/api/excel/workbook/Border#color)	Number	边框的颜色
[Weight](/api/excel/workbook/Border#weight)	[Enum.XlBorderWeight](/api/excel/workbook/Enum#xlborderweight)	边框的粗细
[LineStyle](/api/excel/workbook/Border#linestyle)	[Enum.XlLineStyle](/api/excel/workbook/Enum#xllinestyle)	边框的线条样式

图形(Shape)

某个工作表上的单个 Shape 图形对象

属性	数据类型	简介
[ID](/api/excel/workbook/Shape#id)	String	图形 ID
[Name](/api/excel/workbook/Shape#name)	String	图形名称
[Title](/api/excel/workbook/Shape#title)	String	图形标题
[Chart](/api/excel/workbook/Shape#chart)	[Chart](/api/excel/workbook/Chart)	图表对象

方法	返回类型	简介
[Delete](/api/excel/workbook/Shape#delete)	undefined	删除Shape

图表(Chart)

单个图表对象

属性	数据类型	简介
[ChartTitle.Text](/api/excel/workbook/Chart#charttitle-text)	String	图表标题
[HasTitle](/api/excel/workbook/Chart#hastitle)	Boolean	图表标题是否可见

方法	返回类型	简介
[SetSourceData()](/api/excel/workbook/Chart#setsourcedata)	undefined	为图表设置源数据区域

超链接(Hyperlink)

单个超链接对象，有转跳地址和显示文本两个属性，两者可以不相等。

属性	数据类型	简介
[Address](/api/excel/workbook/Hyperlink#address)	String	超链接转跳的地址
[TextToDisplay](/api/excel/workbook/Hyperlink#texttodisplay)	String	超链接显示的文本

条件格式集合(FormatConditions)

FormatConditions 集合对象用于控制 Excel 中的条件格式。

属性	数据类型	简介
[Count](/api/excel/workbook/FormatConditions#count)	Number	返回 FormatConditions 集合中的对象数

方法	返回类型	简介
[Add()](/api/excel/workbook/FormatConditions#add)	[FormatCondition](/api/excel/workbook/FormatCondition)	向 FormatConditions 集合中添加一个条件格式
[AddAboveAverage()](/api/excel/workbook/FormatConditions#addaboveaverage)	AboveAverage	返回表示指定区域的条件格式规则的新 AboveAverage 对象
[AddIconSetCondition()](/api/excel/workbook/FormatConditions#addiconsetcondition)	IconSetCondition	代表指定区域的图标集条件格式规则
[AddColorScale()](/api/excel/workbook/FormatConditions#addcolorscale)	ColorScale	该条件格式规则使用单元格颜色中的渐变来指示所选区域中包含的单元格值的相对差异
[AddTop10()](/api/excel/workbook/FormatConditions#addtop10)	Top10	该条件格式可以根据指定的截止值查找单元格区域中的最高值和最低值
[AddUniqueValues()](/api/excel/workbook/FormatConditions#adduniquevalues)	UniqueValues	返回表示指定区域的条件格式规则的新 UniqueValues 对象
[Delete()](/api/excel/workbook/FormatConditions#delete)	undefined	删除该区域下的条件格式
[Item()](/api/excel/workbook/FormatConditions#item)	[FormatCondition](/api/excel/workbook/FormatCondition)	从条件格式集合中返回一个条件格式对象

条件格式(FormatCondition)

区域内的某个条件格式

属性	数据类型	简介
[AppliesTo](/api/excel/workbook/FormatCondition#appliesto)	[Range](/api/excel/workbook/Range)	应用格式规则的单元格区域
[Borders](/api/excel/workbook/FormatCondition#borders)	[Border](/api/excel/workbook/Border)	返回一个 Borders 集合
[Font](/api/excel/workbook/FormatCondition#font)	[Font](/api/excel/workbook/Font)	返回一个 Font 对象
[Formula1](/api/excel/workbook/FormatCondition#formula1)	String	返回与条件格式或者数据有效性相关联的值或表达式
[Formula2](/api/excel/workbook/FormatCondition#formula2)	String	返回与条件格式或数据有效性验证第二部分相关联的值或表达式
[Interior](/api/excel/workbook/FormatCondition#interior)	Interior	表示指定对象的内部
[NumberFormat](/api/excel/workbook/FormatCondition#numberformat)	String	单元格的数字格式
[Operator](/api/excel/workbook/FormatCondition#operator)	[XlFormatConditionOperator](/api/excel/workbook/Enum#xlformatconditionoperator)	条件格式的运算符
[Priority](/api/excel/workbook/FormatCondition#priority)	Number	返回或设置条件格式规则的优先级值
[Type](/api/excel/workbook/FormatCondition#type)	[XlFormatConditionType](/api/excel/workbook/Enum#xlformatconditiontype)	条件格式对象类型

方法	返回类型	简介
[Modify()](/api/excel/workbook/FormatCondition#modify)	undefined	更改现有条件格式
[ModifyAppliesToRange()](/api/excel/workbook/FormatCondition#modifyappliestorange)	undefined	设置此格式规则所应用于的单元格区域
[SetFirstPriority()](/api/excel/workbook/FormatCondition#setfirstpriority)	undefined	将此条件格式规则的优先级值设置为“1”
[SetLastPriority()](/api/excel/workbook/FormatCondition#setlastpriority)	undefined	将此条件格式规则的优先级值增加“1”

数据有效性规则(Validation)

代表工作表区域的数据有效性规则

方法	返回类型	简介
[Add()](/api/excel/workbook/Validation#add)	undefined	新增数据有效性规则
[Modify()](/api/excel/workbook/Validation#modify)	undefined	修改数据有效性规则
[Delete()](/api/excel/workbook/Validation#delete)	undefined	删除数据有效性规则

工作表函数(WorksheetFunction)

工作表函数对象是 Excel 中的一个内置对象，它包含了许多常用的 Excel 函数，例如 Sum、Average、Min、Max 等。使用 WorksheetFunction 对象可以在 VBA 中调用这些 Excel 函数，以实现对工作表数据的处理和分析。

方法	返回类型	简介
[Average()](/api/excel/workbook/WorksheetFunction#average)	Number	用于计算指定区域内数字的平均值
[AverageIf()](/api/excel/workbook/WorksheetFunction#averageif)	Number	用于计算指定区域内满足给定条件的所有单元格的平均值
[Small()](/api/excel/workbook/WorksheetFunction#small)	Number	返回数据集中第 k 个最小值
[Large()](/api/excel/workbook/WorksheetFunction#large)	Number	用于在一个数组或一列数据中返回第 k 个最大值
[Min()](/api/excel/workbook/WorksheetFunction#min)	Number	用于在一个数组或一列数据中返回最小值
[Max()](/api/excel/workbook/WorksheetFunction#max)	Number	用于在一个数组或一列数据中返回最大值
[Sum()](/api/excel/workbook/WorksheetFunction#sum)	Number	对某单元格区域中的所有数字求和

枚举(Enum)

枚举类型，存放在 Application 下