接口 IWorksheet
public interface IWorksheet
代表一个工作表。
-
方法概要
修饰符和类型方法说明void
activate()
使当前工作表成为活动工作表。copy()
复制该工作表到当前工作簿的末尾。复制该工作表到指定工作簿的末尾。copyAfter
(IWorksheet targetSheet) 复制该工作表到指定工作表之后的位置。copyBefore
(IWorksheet targetSheet) 复制该工作表到指定工作表之前的位置。void
delete()
删除该对象。将Microsoft Excel名称转换为对象或值。evaluate
(String formula, IFormulaResolver resolver) void
freezePanes
(int row, int column) 冻结指定位置的面板。void
freezeTrailingPanes
(int row, int column) 冻结在指定位置的后续窗格。void
fromJson
(InputStream stream) 从JSON流生成工作表。void
fromJson
(InputStream stream, DeserializationOptions deserializationOptions) void
生成一个工作表从JSON字符串。void
fromJson
(String json, DeserializationOptions deserializationOptions) 发生当工作表被激活时。获取活动单元格。返回表示工作表活动窗格的IPane
对象。返回一个IAutoFilter
对象,如果开启了过滤。boolean
获取当前工作表上是否显示自动筛选的下拉箭头。boolean
获取在绑定数据时是否自动生成列。byte[]
获取此工作表的背景图形。返回一个代表工作表或图表表上所有背景图片的IBackgroundPictures
对象。发生在工作表被删除之前。getCells()
返回代表工作表上所有单元格(不仅仅是当前正在使用的单元格)的IRange
对象。获取工作表的单元格类型。发生当单元格中的某些内容发生变化时。int
获取工作表在导出为json时的列数。返回代表指定工作表上所有列的IRange
对象。返回代表指定工作表的全部注释的IComments
集合。返回代表指定工作表的全部线程注释的ICommentsThreaded
集合。获取此工作表的控件集合。获取当前工作表的数据绑定的数据源。发生当工作表被停用时。boolean
获取工作表是否处于筛选模式。boolean
获取在插入/删除行/列时水平页分割线和垂直页分割线是否固定。int
获取冻结列。int
获取冻结行。int
获取工作表尾部冻结列的数量。int
获取工作表的尾随冻结行数。获取冰冻线的颜色。获取打印区域内水平分页符的集合。提供访问工作表中包含的超链接集合的权限。int
getIndex()
获取对象在类似对象集合中的索引编号。getName()
获取对象的名称。getNames()
返回代表所有工作表特定名称(使用"WorksheetName!"返回一个代表指定工作表的轮廓的IOutline
对象。获取工作表的大纲列。返回一个包含指定对象的所有页面设置信息的IPageSetup
对象。getPanes()
工作表窗格。返回一个代表单个数据透视表报告的IPivotTables
对象,或者代表工作表上所有数据透视表报告的IPivotTables
对象集合。boolean
获取工作表的保护状态。返回表示工作表保护选项的IProtectionSettings
对象。getRange
(int row, int column) 获取指定行和列的IRange
对象。getRange
(int row, int column, int rowCount, int columnCount) 获取指定行和列的IRange
对象。获取具有指定引用的IRange
对象。int
获取工作表导出为json时的行数。getRows()
返回代表指定工作表上所有行的IRange
对象。获取选择范围。发生当工作表上的选择更改时。返回一个IShapes
对象,该对象表示工作表或图表表上的所有形状。返回一个代表此工作表视图设置的对象。boolean
获取是否显示列轮廓的设置。boolean
获取是否显示行轮廓。getSort()
返回当前工作表中的排序值。int
获取分割列。int
获取分割行。double
获取工作表中所有行的标准(默认)高度(以点为单位)。double
获取工作表中所有行的标准(默认)高度(以磅为单位)。double
获取工作表中所有列的标准(默认)宽度(以点为单位)。double
获取工作表中所有列的标准(默认)宽度(以像素为单位)。获取标签的主颜色。返回工作表中的一组ITable
对象。getTag()
获取工作表的标签。getType()
获取工作表的类型。获取使用范围,其行为等同于调用 getUsedRange(EnumSet.of(UsedRangeType.Axis, UsedRangeType.Data, UsedRangeType.Comment, UsedRangeType.Style, UsedRangeType.Merge))。getUsedRange
(EnumSet<UsedRangeType> type) 获取对象是否可见。获取打印区域内所有垂直分页符的集合。返回工作簿。move()
将工作表移动到当前工作簿的末尾。将工作表移动到指定工作簿的末尾。moveAfter
(IWorksheet targetSheet) 将工作表移动到指定工作表之后的位置。moveBefore
(IWorksheet targetSheet) 将工作表移动到指定工作表之前的位置。void
protect()
保护工作表,使其不能被修改。void
保护工作表,使其不能被修改。void
save
(OutputStream fileStream, SaveFileFormat fileFormat) 保存当前工作表到指定格式的文件流。void
save
(OutputStream fileStream, SaveOptionsBase options) 保存当前工作表到指定的文件流。void
保存当前工作表到指定的文件。void
save
(String fileName, SaveFileFormat fileFormat) 保存当前工作表到指定格式的文件。void
save
(String fileName, SaveOptionsBase options) 保存当前工作表到指定文件。void
select()
选择对象。void
select
(boolean replace) 选择对象。void
setAutoFilterMode
(boolean value) 设置是否在表格上显示自动筛选的下拉箭头。void
setAutoGenerateColumns
(boolean value) 设置在绑定数据时是否自动生成列。void
setBackgroundPicture
(byte[] picture) 设置此工作表的背景图形。void
setCellType
(BaseCellType cellType) 设置工作表的单元格类型。void
setColumnCount
(int value) 设置当工作表导出为json时的列数。void
setDataSource
(Object value) 设置当前工作表的数据绑定的数据源。void
setFixedPageBreaks
(boolean value) 设置在插入/删除行/列时是否固定水平和垂直的分页符。void
setFrozenLineColor
(Color value) 设置冻结线条的颜色。void
setIndex
(int value) 设置对象在相似对象集合中的索引编号。void
设置对象的名称。void
setProtection
(boolean value) 设置工作表的保护状态。void
setRowCount
(int value) 设置当工作表导出为json时的行数。void
setShowColumnOutline
(boolean value) 设置是否显示列轮廓。void
setShowRowOutline
(boolean value) 设置是否显示行轮廓。void
setStandardHeight
(double value) 设置工作表中所有行的标准(默认)高度(以点为单位)。void
setStandardHeightInPixel
(double value) 设置工作表中所有行的标准(默认)高度(以磅为单位)。void
setStandardWidth
(double value) 设置工作表中所有列的标准(默认)宽度(以点为单位)。void
setStandardWidthInPixel
(double value) 设置工作表中所有列的标准(默认)宽度(以像素为单位)。void
setTabColor
(Color value) 设置标签的主色调。void
设置工作表的标签。void
setVisible
(Visibility value) 设置对象是否可见。void
使当前筛选列表的所有行可见。void
splitPanes
(int row, int column) 在指定的位置拆分窗格。void
toImage
(OutputStream stream, ImageType imageType) 保存工作表到指定的图像文件。void
toImage
(OutputStream stream, ImageType imageType, ImageSaveOptions options) 保存工作表到指定的图像文件,使用选项。void
保存工作表到指定的图像文件。void
toImage
(String imageFile, ImageSaveOptions options) 保存工作表到指定的图像文件,使用设置的选项。toJson()
从工作表中生成一个JSON字符串。toJson
(SerializationOptions serializationOptions) 生成一个从工作表中的JSON字符串。void
toJson
(OutputStream stream) 生成工作表的json流。void
toJson
(OutputStream stream, SerializationOptions serializationOptions) 生成一个来自工作表的JSON流。void
解冻窗格。void
解冻尾随窗格。void
移除工作表的保护。void
移除工作表的保护。void
取消分割窗格。
-
方法详细资料
-
getActivatedEvent
Event<EventHandler<EventArgs>> getActivatedEvent()发生当工作表被激活时。 -
getBeforeDeleteEvent
Event<EventHandler<EventArgs>> getBeforeDeleteEvent()发生在工作表被删除之前。 -
getChangedEvent
Event<EventHandler<RangeEventArgs>> getChangedEvent()发生当单元格中的某些内容发生变化时。 -
getDeactivatedEvent
Event<EventHandler<EventArgs>> getDeactivatedEvent()发生当工作表被停用时。 -
getSelectionChangeEvent
Event<EventHandler<RangeEventArgs>> getSelectionChangeEvent()发生当工作表上的选择更改时。 -
getControls
IControlCollection getControls()获取此工作表的控件集合。 -
getSheetView
IWorksheetView getSheetView()返回一个代表此工作表视图设置的对象。 -
getVisible
Visibility getVisible()获取对象是否可见。 -
setVisible
设置对象是否可见。 -
getActiveCell
IRange getActiveCell()获取活动单元格。 -
getAutoFilter
IAutoFilter getAutoFilter()返回一个IAutoFilter
对象,如果开启了过滤。如果关闭了过滤,则不返回任何内容。 -
getAutoFilterMode
boolean getAutoFilterMode()获取当前工作表上是否显示自动筛选的下拉箭头。 -
setAutoFilterMode
void setAutoFilterMode(boolean value) 设置是否在表格上显示自动筛选的下拉箭头。 -
getColumns
IRange getColumns()返回代表指定工作表上所有列的IRange
对象。 -
getCells
IRange getCells()返回代表工作表上所有单元格(不仅仅是当前正在使用的单元格)的IRange
对象。 -
getComments
IComments getComments()返回代表指定工作表的全部注释的IComments
集合。 -
getCommentsThreaded
ICommentsThreaded getCommentsThreaded()返回代表指定工作表的全部线程注释的ICommentsThreaded
集合。 -
getStandardWidth
double getStandardWidth()获取工作表中所有列的标准(默认)宽度(以点为单位)。 -
getStandardWidthInPixel
double getStandardWidthInPixel()获取工作表中所有列的标准(默认)宽度(以像素为单位)。 -
setStandardWidth
void setStandardWidth(double value) 设置工作表中所有列的标准(默认)宽度(以点为单位)。 -
setStandardWidthInPixel
void setStandardWidthInPixel(double value) 设置工作表中所有列的标准(默认)宽度(以像素为单位)。 -
getStandardHeight
double getStandardHeight()获取工作表中所有行的标准(默认)高度(以点为单位)。 -
getStandardHeightInPixel
double getStandardHeightInPixel()获取工作表中所有行的标准(默认)高度(以磅为单位)。 -
setStandardHeight
void setStandardHeight(double value) 设置工作表中所有行的标准(默认)高度(以点为单位)。 -
setStandardHeightInPixel
void setStandardHeightInPixel(double value) 设置工作表中所有行的标准(默认)高度(以磅为单位)。 -
getFilterMode
boolean getFilterMode()获取工作表是否处于筛选模式。 -
getHyperlinks
IHyperlinks getHyperlinks()提供访问工作表中包含的超链接集合的权限。 -
getIndex
int getIndex()获取对象在类似对象集合中的索引编号。 -
setIndex
void setIndex(int value) 设置对象在相似对象集合中的索引编号。 -
getRowCount
int getRowCount()获取工作表导出为json时的行数。 -
setRowCount
void setRowCount(int value) 设置当工作表导出为json时的行数。 -
getColumnCount
int getColumnCount()获取工作表在导出为json时的列数。 -
setColumnCount
void setColumnCount(int value) 设置当工作表导出为json时的列数。 -
getBackgroundPicture
byte[] getBackgroundPicture()获取此工作表的背景图形。 -
setBackgroundPicture
void setBackgroundPicture(byte[] picture) 设置此工作表的背景图形。 -
getName
String getName()获取对象的名称。 -
setName
设置对象的名称。 -
getNames
INames getNames()返回代表所有工作表特定名称(使用"WorksheetName!"前缀定义的名称)的INames
集合。 -
getOutline
IOutline getOutline()返回一个代表指定工作表的轮廓的IOutline
对象。 -
getShowRowOutline
boolean getShowRowOutline()获取是否显示行轮廓。默认值为true,此属性仅在与SJS交互时适用。 -
setShowRowOutline
void setShowRowOutline(boolean value) 设置是否显示行轮廓。默认值为true,此属性仅在与SJS交互时适用。 -
getShowColumnOutline
boolean getShowColumnOutline()获取是否显示列轮廓的设置。默认值为true,此属性仅在与SJS交互时适用。 -
setShowColumnOutline
void setShowColumnOutline(boolean value) 设置是否显示列轮廓。默认值为true,此属性仅在与SJS交互时适用。 -
getPivotTables
IPivotTables getPivotTables()返回一个代表单个数据透视表报告的IPivotTables
对象,或者代表工作表上所有数据透视表报告的IPivotTables
对象集合。 -
getRange
获取具有指定引用的IRange
对象。- 参数:
reference
- 引用。- 返回:
- 范围。
-
getRange
获取指定行和列的IRange
对象。- 参数:
row
- 行。column
- 列。- 返回:
- 返回范围。
-
getRange
获取指定行和列的IRange
对象。- 参数:
row
- 行。column
- 列。rowCount
- 行数。columnCount
- 列数。- 返回:
- 范围。
-
getSelection
IRange getSelection()获取选择范围。 -
getShapes
IShapes getShapes()返回一个IShapes
对象,该对象表示工作表或图表表上的所有形状。 -
getBackgroundPictures
IBackgroundPictures getBackgroundPictures()返回一个代表工作表或图表表上所有背景图片的IBackgroundPictures
对象。 -
getSort
ISort getSort()返回当前工作表中的排序值。 -
getTabColor
Color getTabColor()获取标签的主颜色。 -
setTabColor
设置标签的主色调。 -
getTables
ITables getTables()返回工作表中的一组ITable
对象。 -
getWorkbook
IWorkbook getWorkbook()返回工作簿。 -
getProtectionSettings
IProtectionSettings getProtectionSettings()返回表示工作表保护选项的IProtectionSettings
对象。 -
getProtection
boolean getProtection()获取工作表的保护状态。 -
setProtection
void setProtection(boolean value) 设置工作表的保护状态。 -
getRows
IRange getRows()返回代表指定工作表上所有行的IRange
对象。 -
getFreezeRow
int getFreezeRow()获取冻结行。 -
getFreezeColumn
int getFreezeColumn()获取冻结列。 -
getFrozenLineColor
Color getFrozenLineColor()获取冰冻线的颜色。 -
getFreezeTrailingRow
int getFreezeTrailingRow()获取工作表的尾随冻结行数。 -
getFreezeTrailingColumn
int getFreezeTrailingColumn()获取工作表尾部冻结列的数量。 -
setFrozenLineColor
设置冻结线条的颜色。 -
getSplitRow
int getSplitRow()获取分割行。 -
getSplitColumn
int getSplitColumn()获取分割列。 -
getPageSetup
IPageSetup getPageSetup()返回一个包含指定对象的所有页面设置信息的IPageSetup
对象。 -
getHPageBreaks
IHPageBreaks getHPageBreaks()获取打印区域内水平分页符的集合。 -
getVPageBreaks
IVPageBreaks getVPageBreaks()获取打印区域内所有垂直分页符的集合。 -
select
void select()选择对象。 -
select
void select(boolean replace) 选择对象。- 参数:
replace
- 如果为True,则用指定的对象替换当前选择。如果为False,则将当前选择扩展以包括任何先前选定的对象和指定的对象。
-
activate
void activate()使当前工作表成为活动工作表。这相当于点击工作表的标签。 -
delete
void delete()删除该对象。 -
evaluate
将Microsoft Excel名称转换为对象或值。- 参数:
formula
- 必需的字符串。使用命名约定的对象名称。
-
evaluate
- 参数:
formula
- 公式resolver
- 解析器- 返回:
- 计算结果
-
showAllData
void showAllData()使当前筛选列表的所有行可见。如果使用了自动筛选,此方法会将箭头改为“全部”。 -
getUsedRange
IRange getUsedRange()获取使用范围,其行为等同于调用 getUsedRange(EnumSet.of(UsedRangeType.Axis, UsedRangeType.Data, UsedRangeType.Comment, UsedRangeType.Style, UsedRangeType.Merge))。 -
getUsedRange
- 参数:
type
- 特性类型。- 返回:
- 表示在指定工作表上使用的范围的
IRange
对象。
-
freezePanes
void freezePanes(int row, int column) 冻结指定位置的面板。- 参数:
row
- 冻结行的位置。column
- 冻结列的位置。
-
unfreezePanes
void unfreezePanes()解冻窗格。 -
freezeTrailingPanes
void freezeTrailingPanes(int row, int column) 冻结在指定位置的后续窗格。- 参数:
row
- 后续冻结行的位置。column
- 后续冻结列的位置。
-
unfreezeTrailingPanes
void unfreezeTrailingPanes()解冻尾随窗格。 -
splitPanes
void splitPanes(int row, int column) 在指定的位置拆分窗格。- 参数:
row
- 拆分的行位置。column
- 拆分的列位置。
-
unsplitPanes
void unsplitPanes()取消分割窗格。 -
getPanes
IPanes getPanes()工作表窗格。 -
getActivePane
IPane getActivePane()返回表示工作表活动窗格的IPane
对象。 -
save
保存当前工作表到指定的文件。- 参数:
fileName
- 指定的文件名。
-
save
保存当前工作表到指定格式的文件。- 参数:
fileName
- 指定的文件。fileFormat
- 文件的格式。
-
save
保存当前工作表到指定格式的文件流。- 参数:
fileStream
- 指定的文件流。fileFormat
- 文件流的格式。
-
save
保存当前工作表到指定文件。- 参数:
fileName
- 指定的文件。options
- 保存文件时的选项。
-
save
保存当前工作表到指定的文件流。- 参数:
fileStream
- 指定的文件流。options
- 保存文件流时的选项。
-
getFixedPageBreaks
boolean getFixedPageBreaks()获取在插入/删除行/列时水平页分割线和垂直页分割线是否固定。 -
setFixedPageBreaks
void setFixedPageBreaks(boolean value) 设置在插入/删除行/列时是否固定水平和垂直的分页符。 -
getType
SheetType getType()获取工作表的类型。 -
getTag
Object getTag()获取工作表的标签。 -
setTag
设置工作表的标签。 -
getCellType
BaseCellType getCellType()获取工作表的单元格类型。 -
setCellType
设置工作表的单元格类型。 -
getDataSource
Object getDataSource()获取当前工作表的数据绑定的数据源。 -
setDataSource
设置当前工作表的数据绑定的数据源。 -
getAutoGenerateColumns
boolean getAutoGenerateColumns()获取在绑定数据时是否自动生成列。 -
setAutoGenerateColumns
void setAutoGenerateColumns(boolean value) 设置在绑定数据时是否自动生成列。 -
getOutlineColumn
IOutlineColumn getOutlineColumn()获取工作表的大纲列。 -
copy
IWorksheet copy()复制该工作表到当前工作簿的末尾。- 返回:
- 新复制的工作表
-
copy
复制该工作表到指定工作簿的末尾。- 参数:
workbook
- 指定要复制工作表到的工作簿。- 返回:
- 新复制的工作表。
-
copyBefore
复制该工作表到指定工作表之前的位置。- 参数:
targetSheet
- 复制后工作表将要放置在它之前的工作表。这可以是同一工作簿或另一个工作簿中的工作表。- 返回:
- 新复制的工作表。
-
copyAfter
复制该工作表到指定工作表之后的位置。- 参数:
targetSheet
- 被复制工作表将要放置在之后的工作表。它可以是在同一个或另一个工作簿中的工作表。- 返回:
- 新复制的工作表
-
move
IWorksheet move()将工作表移动到当前工作簿的末尾。- 返回:
- 被移动的工作表
-
move
将工作表移动到指定工作簿的末尾。- 参数:
workbook
- 指定要将工作表移动到的目标工作簿。- 返回:
- 被移动的工作表。
-
moveBefore
将工作表移动到指定工作表之前的位置。- 参数:
targetSheet
- 移动后工作表将被放置在其前的工作表。它可以是同一工作簿或另一个工作簿中的工作表。- 返回:
- 被移动的工作表
-
moveAfter
将工作表移动到指定工作表之后的位置。- 参数:
targetSheet
- 被移动的工作表将放置在其之后的工作表。它可以是同一工作簿或另一个工作簿中的工作表。- 返回:
- 被移动的工作表
-
toJson
String toJson()从工作表中生成一个JSON字符串。 -
toJson
生成一个从工作表中的JSON字符串。- 参数:
serializationOptions
-SerializationOptions
对象。- 返回:
- JSON字符串。
-
toJson
生成工作表的json流。- 参数:
stream
- 输出流。
-
toJson
生成一个来自工作表的JSON流。- 参数:
stream
- 输出流。serializationOptions
-SerializationOptions
对象。
-
fromJson
生成一个工作表从JSON字符串。- 参数:
json
- 输入的JSON字符串。
-
fromJson
- 参数:
json
- 输入的json字符串。deserializationOptions
-DeserializationOptions
对象。
-
fromJson
从JSON流生成工作表。- 参数:
stream
- 输入的JSON流。
-
fromJson
- 参数:
stream
- 输入的JSON流。deserializationOptions
-DeserializationOptions
对象。
-
toImage
保存工作表到指定的图像文件。- 参数:
imageFile
- 输出的图像文件。
-
toImage
保存工作表到指定的图像文件,使用设置的选项。- 参数:
imageFile
- 输出的图像文件。options
- 输出图像的选项。
-
toImage
保存工作表到指定的图像文件。- 参数:
stream
- 输出图像流。imageType
- 指定要创建的图像类型。
-
toImage
保存工作表到指定的图像文件,使用选项。- 参数:
stream
- 输出图像流。imageType
- 指定要创建的图像类型。options
- 输出图像的选项。
-
protect
void protect()保护工作表,使其不能被修改。 -
protect
保护工作表,使其不能被修改。- 参数:
password
- 用于保护工作表的密码。
-
unprotect
void unprotect()移除工作表的保护。 -
unprotect
移除工作表的保护。- 参数:
password
- 用于保护工作表的密码。
-