Package com.grapecity.documents.excel

Interface IWorksheet

public interface IWorksheet
代表一个工作表。

  • Method Details

    • 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

      void setVisible(Visibility value)
      设置对象是否可见。

    • 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

      void setName(String value)
      设置对象的名称。

    • 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 getRange(String reference)
      获取具有指定引用的IRange对象。
      Parameters:
      reference - 引用。
      Returns:
      范围。

    • getRange

      IRange getRange(int row, int column)
      获取指定行和列的 IRange 对象。
      Parameters:
      row - 行。
      column - 列。
      Returns:
      返回范围。

    • getRange

      IRange getRange(int row, int column, int rowCount, int columnCount)
      获取指定行和列的 IRange 对象。
      Parameters:
      row - 行。
      column - 列。
      rowCount - 行数。
      columnCount - 列数。
      Returns:
      范围。

    • getSelection

      IRange getSelection()
      获取选择范围。

    • getShapes

      IShapes getShapes()
      返回一个IShapes对象，该对象表示工作表或图表表上的所有形状。

    • getBackgroundPictures

      IBackgroundPictures getBackgroundPictures()
      返回一个代表工作表或图表表上所有背景图片的IBackgroundPictures对象。

    • getSort

      ISort getSort()
      返回当前工作表中的排序值。

    • getTabColor

      Color getTabColor()
      获取标签的主颜色。

    • setTabColor

      void setTabColor(Color value)
      设置标签的主色调。

    • 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

      void setFrozenLineColor(Color value)
      设置冻结线条的颜色。

    • getSplitRow

      int getSplitRow()
      获取分割行。

    • getSplitColumn

      int getSplitColumn()
      获取分割列。

    • getPageSetup

      IPageSetup getPageSetup()
      返回一个包含指定对象的所有页面设置信息的IPageSetup对象。

    • getHPageBreaks

      IHPageBreaks getHPageBreaks()
      获取打印区域内水平分页符的集合。

    • getVPageBreaks

      IVPageBreaks getVPageBreaks()
      获取打印区域内所有垂直分页符的集合。

    • select

      void select()
      选择对象。

    • select

      void select(boolean replace)
      选择对象。
      Parameters:
      replace - 如果为True，则用指定的对象替换当前选择。如果为False，则将当前选择扩展以包括任何先前选定的对象和指定的对象。

    • activate

      void activate()
      使当前工作表成为活动工作表。这相当于点击工作表的标签。

    • delete

      void delete()
      删除该对象。

    • evaluate

      Object evaluate(String formula)
      计算指定的 Excel 公式或命名表达式并返回结果。 计算行为与 Excel 2019 及更早版本一致。
      Parameters:
      formula - 包含要计算的 Excel 公式、命名区域或定义名称的字符串。
      Returns:
      计算结果。 当公式结果为引用（如 "=A1"）时，将返回一个 IRange 对象。

    • evaluate2

      Object evaluate2(String formula)
      计算指定的 Excel 公式或命名表达式，并返回结果。 计算行为与 Excel 2021/365 保持一致。
      Parameters:
      formula - 包含要计算的 Excel 公式、命名区域或定义名称的字符串。
      Returns:
      计算结果，形式如下：
      • 标准公式返回单个值
      • 动态数组公式返回二维对象数组（Object[][]），第一维为行，第二维为列
      • 如果公式返回引用（如 "=A1:A5"），则返回 IRange 对象

    • evaluate

      Object evaluate(String formula, IFormulaResolver resolver)
      Parameters:
      formula - 公式
      resolver - 解析器
      Returns:
      计算结果

    • showAllData

      void showAllData()
      使当前筛选列表的所有行可见。如果使用了自动筛选，此方法会将箭头改为“全部”。

    • getUsedRange

      IRange getUsedRange()
      获取使用范围，其行为等同于调用 getUsedRange(EnumSet.of(UsedRangeType.Axis, UsedRangeType.Data, UsedRangeType.Comment, UsedRangeType.Style, UsedRangeType.Merge))。

    • getUsedRange

      IRange getUsedRange(EnumSet<UsedRangeType> type)
      Parameters:
      type - 特性类型。
      Returns:
      表示在指定工作表上使用的范围的IRange对象。

    • freezePanes

      void freezePanes(int row, int column)
      冻结指定位置的面板。
      Parameters:
      row - 冻结行的位置。
      column - 冻结列的位置。

    • unfreezePanes

      void unfreezePanes()
      解冻窗格。

    • freezeTrailingPanes

      void freezeTrailingPanes(int row, int column)
      冻结在指定位置的后续窗格。
      Parameters:
      row - 后续冻结行的位置。
      column - 后续冻结列的位置。

    • unfreezeTrailingPanes

      void unfreezeTrailingPanes()
      解冻尾随窗格。

    • splitPanes

      void splitPanes(int row, int column)
      在指定的位置拆分窗格。
      Parameters:
      row - 拆分的行位置。
      column - 拆分的列位置。

    • unsplitPanes

      void unsplitPanes()
      取消分割窗格。

    • getPanes

      IPanes getPanes()
      工作表窗格。

    • getActivePane

      IPane getActivePane()
      返回表示工作表活动窗格的IPane对象。

    • save

      void save(String fileName)
      保存当前工作表到指定的文件。
      Parameters:
      fileName - 指定的文件名。

    • save

      void save(String fileName, SaveFileFormat fileFormat)
      保存当前工作表到指定格式的文件。
      Parameters:
      fileName - 指定的文件。
      fileFormat - 文件的格式。

    • save

      void save(OutputStream fileStream, SaveFileFormat fileFormat)
      保存当前工作表到指定格式的文件流。
      Parameters:
      fileStream - 指定的文件流。
      fileFormat - 文件流的格式。

    • save

      void save(String fileName, SaveOptionsBase options)
      保存当前工作表到指定文件。
      Parameters:
      fileName - 指定的文件。
      options - 保存文件时的选项。

    • save

      void save(OutputStream fileStream, SaveOptionsBase options)
      保存当前工作表到指定的文件流。
      Parameters:
      fileStream - 指定的文件流。
      options - 保存文件流时的选项。

    • getFixedPageBreaks

      boolean getFixedPageBreaks()
      获取在插入/删除行/列时水平页分割线和垂直页分割线是否固定。

    • setFixedPageBreaks

      void setFixedPageBreaks(boolean value)
      设置在插入/删除行/列时是否固定水平和垂直的分页符。

    • getType

      SheetType getType()
      获取工作表的类型。

    • getTag

      Object getTag()
      获取工作表的标签。

    • setTag

      void setTag(Object tag)
      设置工作表的标签。

    • getCellType

      BaseCellType getCellType()
      获取工作表的单元格类型。

    • setCellType

      void setCellType(BaseCellType cellType)
      设置工作表的单元格类型。

    • getDataSource

      Object getDataSource()
      获取当前工作表的数据绑定的数据源。

    • setDataSource

      void setDataSource(Object value)
      设置当前工作表的数据绑定的数据源。

    • getAutoGenerateColumns

      boolean getAutoGenerateColumns()
      获取在绑定数据时是否自动生成列。

    • setAutoGenerateColumns

      void setAutoGenerateColumns(boolean value)
      设置在绑定数据时是否自动生成列。

    • getOutlineColumn

      IOutlineColumn getOutlineColumn()
      获取工作表的大纲列。

    • getScenarios

      IScenarios getScenarios()
      获取表示工作表上方案集合的 IScenarios 对象。

    • getAutoMergeRangesInfo

      List<IAutoMergeRangeInfo> getAutoMergeRangesInfo()
      获取一个 IAutoMergeRangeInfo 对象列表，表示当前工作表的所有自动合并范围信息。

    • copy

      IWorksheet copy()
      复制该工作表到当前工作簿的末尾。
      Returns:
      新复制的工作表

    • copy

      IWorksheet copy(IWorkbook workbook)
      复制该工作表到指定工作簿的末尾。
      Parameters:
      workbook - 指定要复制工作表到的工作簿。
      Returns:
      新复制的工作表。

    • copyBefore

      IWorksheet copyBefore(IWorksheet targetSheet)
      复制该工作表到指定工作表之前的位置。
      Parameters:
      targetSheet - 复制后工作表将要放置在它之前的工作表。这可以是同一工作簿或另一个工作簿中的工作表。
      Returns:
      新复制的工作表。

    • copyAfter

      IWorksheet copyAfter(IWorksheet targetSheet)
      复制该工作表到指定工作表之后的位置。
      Parameters:
      targetSheet - 被复制工作表将要放置在之后的工作表。它可以是在同一个或另一个工作簿中的工作表。
      Returns:
      新复制的工作表

    • move

      IWorksheet move()
      将工作表移动到当前工作簿的末尾。
      Returns:
      被移动的工作表

    • move

      IWorksheet move(IWorkbook workbook)
      将工作表移动到指定工作簿的末尾。
      Parameters:
      workbook - 指定要将工作表移动到的目标工作簿。
      Returns:
      被移动的工作表。

    • moveBefore

      IWorksheet moveBefore(IWorksheet targetSheet)
      将工作表移动到指定工作表之前的位置。
      Parameters:
      targetSheet - 移动后工作表将被放置在其前的工作表。它可以是同一工作簿或另一个工作簿中的工作表。
      Returns:
      被移动的工作表

    • moveAfter

      IWorksheet moveAfter(IWorksheet targetSheet)
      将工作表移动到指定工作表之后的位置。
      Parameters:
      targetSheet - 被移动的工作表将放置在其之后的工作表。它可以是同一工作簿或另一个工作簿中的工作表。
      Returns:
      被移动的工作表

    • toJson

      String toJson()
      从工作表中生成一个JSON字符串。

    • toJson

      String toJson(SerializationOptions serializationOptions)
      生成一个从工作表中的JSON字符串。
      Parameters:
      serializationOptions - SerializationOptions对象。
      Returns:
      JSON字符串。

    • toJson

      void toJson(OutputStream stream)
      生成工作表的json流。
      Parameters:
      stream - 输出流。

    • toJson

      void toJson(OutputStream stream, SerializationOptions serializationOptions)
      生成一个来自工作表的JSON流。
      Parameters:
      stream - 输出流。
      serializationOptions - SerializationOptions对象。

    • fromJson

      void fromJson(String json)
      生成一个工作表从JSON字符串。
      Parameters:
      json - 输入的JSON字符串。

    • fromJson

      void fromJson(String json, DeserializationOptions deserializationOptions)
      Parameters:
      json - 输入的json字符串。
      deserializationOptions - DeserializationOptions 对象。

    • fromJson

      void fromJson(InputStream stream)
      从JSON流生成工作表。
      Parameters:
      stream - 输入的JSON流。

    • fromJson

      void fromJson(InputStream stream, DeserializationOptions deserializationOptions)
      Parameters:
      stream - 输入的JSON流。
      deserializationOptions - DeserializationOptions对象。

    • autoMerge

      void autoMerge(IRange range)
      给范围应用自动合并。自动合并方向为列。自动合并模式为自由模式。自动合并选择模式为源模式。
      Parameters:
      range - 自动合并范围。

    • autoMerge

      void autoMerge(IRange range, AutoMergeDirection direction)
      给范围应用自动合并。自动合并模式为自由模式。自动合并选择模式为源模式。
      Parameters:
      range - 自动合并范围。
      direction - 自动合并方向。

    • autoMerge

      void autoMerge(IRange range, AutoMergeDirection direction, AutoMergeMode mode)
      给范围应用自动合并。自动合并选择模式为源模式。
      Parameters:
      range - 自动合并范围。
      direction - 自动合并方向。特别是，如果方向为 AutoMergeDirection.None，则该范围的自动合并将被取消。
      mode - 自动合并模式。

    • autoMerge

      void autoMerge(IRange range, AutoMergeDirection direction, AutoMergeMode mode, AutoMergeSelectionMode selectionMode)
      给范围应用自动合并。
      Parameters:
      range - 自动合并范围。
      direction - 自动合并方向。特别是，如果方向为 AutoMergeDirection.None，则该范围的自动合并将被取消。
      mode - 自动合并模式。
      selectionMode - 自动合并选择模式。

    • toImage

      void toImage(String imageFile)
      保存工作表到指定的图像文件。
      Parameters:
      imageFile - 输出的图像文件。

    • toImage

      void toImage(String imageFile, ImageSaveOptions options)
      保存工作表到指定的图像文件，使用设置的选项。
      Parameters:
      imageFile - 输出的图像文件。
      options - 输出图像的选项。

    • toImage

      void toImage(OutputStream stream, ImageType imageType)
      保存工作表到指定的图像文件。
      Parameters:
      stream - 输出图像流。
      imageType - 指定要创建的图像类型。

    • toImage

      void toImage(OutputStream stream, ImageType imageType, ImageSaveOptions options)
      保存工作表到指定的图像文件，使用选项。
      Parameters:
      stream - 输出图像流。
      imageType - 指定要创建的图像类型。
      options - 输出图像的选项。

    • protect

      void protect()
      保护工作表，使其不能被修改。

    • protect

      void protect(String password)
      保护工作表，使其不能被修改。
      Parameters:
      password - 用于保护工作表的密码。

    • unprotect

      void unprotect()
      移除工作表的保护。

    • unprotect

      void unprotect(String password)
      移除工作表的保护。
      Parameters:
      password - 用于保护工作表的密码。