ApiWorksheet

表示 ApiWorksheet 类。

属性

名称	类型	描述
Active	number	激活当前工作表。
ActiveCell	ApiRange	返回表示活动单元格的对象。
AllProtectedRanges	ApiProtectedRange[]	返回当前工作表中的所有受保护区域。
AutoFilter	ApiAutoFilter	返回表示所有已应用自动筛选的 AutoFilter
BottomMargin	number	返回或设置以磅为单位的工作表底边距大小。
Cells	ApiRange	返回表示工作表上所有单元格的 ApiRange（不仅限于当前正在使用的单元格）。
Cols	ApiRange	返回表示列区域中所有单元格的 ApiRange。
Comments	ApiComment[]	返回当前工作表中的所有批注。
Defnames	ApiName[]	返回 ApiName 对象数组。
FreezePanes	ApiFreezePanes	返回当前工作表的冻结窗格。
Index	number	返回工作表索引。
LeftMargin	number	返回或设置以磅为单位的工作表左边距大小。
Name	string	返回或设置活动工作表的名称。
PageOrientation	PageOrientation	返回或设置页面方向。
PivotTables	ApiPivotTable[]	返回当前工作表中的所有数据透视表。
PrintGridlines	boolean	返回或设置页面的 PrintGridlines 属性。
PrintHeadings	boolean	返回或设置页面的 PrintHeadings 属性。
RightMargin	number	返回或设置以磅为单位的工作表右边距大小。
Rows	ApiRange	返回表示行区域中所有单元格的 ApiRange。
Selection	ApiRange	返回表示所选范围的对象。
TopMargin	number	返回或设置以磅为单位的工作表顶边距大小。
UsedRange	ApiRange	返回表示指定工作表上已用区域的 ApiRange。
Visible	boolean	返回或设置工作表的可见性状态。

方法

方法	返回值	描述
AddChart	ApiChart | null	从当前工作表的选定数据范围创建指定类型的图表。
AddDefName	boolean	向当前工作表添加新名称。
AddDrawing	boolean	将分离的绘图对象（例如 ApiDrawing.Copy 返回的副本）添加到工作表的指定锚点。
AddImage	ApiImage	使用指定的参数向当前工作表添加图像。
AddListObject	ApiListObject | null	向工作表添加格式化表格并返回 ApiListObject 对象。
AddOleObject	ApiOleObject	使用指定的参数向当前工作表添加 OLE 对象。
AddProtectedRange	ApiProtectedRange | null	从当前工作表的选定数据区域创建指定类型的受保护区域。
AddShape	ApiShape	使用指定的参数向当前工作表添加形状。
AddWordArt	ApiDrawing	使用指定的参数向当前工作表添加艺术字对象。
Delete	boolean	删除当前工作表。
FormatAsTable	boolean	将当前工作表中选定的单元格范围格式化为表格（第一行格式化为标题行）。
GetActiveCell	ApiRange	返回表示活动单元格的对象。
GetAllCharts	ApiChart[]	返回当前工作表中的所有图表。
GetAllDrawings	Drawing[]	返回当前工作表中的所有绘图。
GetAllImages	ApiImage[]	返回当前工作表中的所有图像。
GetAllOleObjects	ApiOleObject[]	返回当前工作表中的所有 OLE 对象。
GetAllPivotTables	ApiPivotTable[]	返回当前工作表中的所有数据透视表。
GetAllProtectedRanges	ApiProtectedRange[] | null	返回当前工作表中的所有受保护区域。
GetAllShapes	ApiShape[]	返回当前工作表中的所有形状。
GetAutoFilter	ApiAutoFilter	返回表示工作表自动筛选的 ApiAutoFilter 对象实例。
GetBottomMargin	number	返回工作表的底边距。
GetCells	ApiRange | null	返回表示工作表上所有单元格的 ApiRange（不仅限于当前正在使用的单元格）。
GetCols	ApiRange	返回表示列区域中所有单元格的 ApiRange 对象。
GetComments	ApiComment[]	返回当前工作表中的所有批注。
GetCustomXmlParts	ApiCustomXmlParts | null	检索与当前工作表关联的自定义 XML 管理器。
GetDefName	ApiName | null	按工作表名称返回 ApiName 对象。
GetDefNames	ApiName[]	返回 ApiName 对象数组。
GetFreezePanes	ApiFreezePanes	返回当前工作表的冻结窗格。
GetIndex	number	返回工作表索引。
GetLeftMargin	number	返回工作表的左边距。
GetListObjects	ApiListObject[]	返回表示工作表上格式化表格的 ApiListObject 对象数组。
GetName	string	返回工作表名称。
GetPageOrientation	PageOrientation	返回页面方向。
GetPivotByName	ApiPivotTable | null	按名称从当前工作表返回数据透视表，如果不存在则返回 null。
GetPrintGridlines	boolean	返回页面 PrintGridlines 属性，该属性指定是否必须打印当前工作表网格线。
GetPrintHeadings	boolean	返回页面 PrintHeadings 属性，该属性指定是否必须打印当前工作表的行/列标题。
GetProtectedRange	ApiProtectedRange | null	按标题返回受保护区域对象。
GetRange	ApiRange | null	返回表示当前工作表选定范围的对象。可以是单个单元格 - A1，或单元格
GetRangeByNumber	ApiRange	返回使用 行/列 坐标进行单元格选择的当前工作表选定区域的对象。
GetRightMargin	number	返回工作表的右边距。
GetRows	ApiRange | null	返回表示行区域中所有单元格的 ApiRange 对象。
GetSelectedDrawings	Drawing[]	返回当前工作表中选定的绘图。
GetSelectedShapes	ApiShape[]	返回当前工作表中选定的形状。
GetSelection	ApiRange	返回表示所选范围的对象。
GetTopMargin	number	返回工作表的顶边距。
GetUsedRange	ApiRange	返回表示指定工作表上已用区域的 ApiRange 对象。
GetVisible	boolean	返回工作表的可见性状态。
Move	无	将当前工作表移动到工作簿中的另一个位置。
Paste	无	将剪贴板的内容粘贴到当前工作表。
RefreshAllPivots	无	刷新当前工作表上的所有数据透视表。
ReplaceCurrentImage	boolean	用新图像替换当前图像。
SetActive	boolean	激活当前工作表。
SetBottomMargin	boolean	设置工作表的底边距。
SetColumnWidth	boolean	设置指定列的宽度。
SetDisplayGridlines	boolean	指定是否必须显示当前工作表网格线。
SetDisplayHeadings	boolean	指定是否必须显示当前工作表的行/列标题。
SetHyperlink	boolean	向指定范围添加超链接。
SetLeftMargin	boolean	设置工作表的左边距。
SetName	无	为当前活动工作表设置名称。
SetPageOrientation	boolean	设置页面方向。
SetPrintGridlines	boolean	指定是否必须打印当前工作表网格线。
SetPrintHeadings	boolean	指定是否必须打印当前工作表的行/列标题。
SetRightMargin	boolean	设置工作表的右边距。
SetRowHeight	boolean	设置以磅为单位的指定行的高度。
SetTopMargin	boolean	设置工作表的顶边距。
SetVisible	boolean	设置工作表的可见性状态。