[]
产品首页 在线Demo 产品文档 API 参考 技术社区
立即试用
(Showing Draft Content)

IRange

Interface IRange

public interface IRange
代表IRange对象。

  • Method Details

    • getRows

      IRange getRows()
      返回代表指定范围内行的IRange对象。

    • getColumns

      IRange getColumns()
      返回代表指定范围内列的IRange对象。

    • getCells

      IRange getCells()
      返回代表指定范围内单元格的IRange对象。

    • getRow

      int getRow()
      返回第一个范围的第一行的行号，行号从0开始计算。

    • getLastRow

      int getLastRow()
      返回第一个范围的最后一行的行号，行号从0开始计算。

    • getRowCount

      int getRowCount()
      返回第一个范围的行数。

    • getColumn

      int getColumn()
      返回第一个范围的第一列的列号，列号从0开始计算。

    • getLastColumn

      int getLastColumn()
      返回第一个范围的最后一列的列号，列号从0开始计算。

    • getColumnCount

      int getColumnCount()
      返回第一个范围内的列数。

    • getCount

      int getCount()
      返回集合中的对象数量。

    • getFont

      IFont getFont()
      返回一个IFont实例，可用于获取和设置由此IRange表示的单元格的字体属性。

    • getBorders

      IBorders getBorders()
      返回一个IBorders实例，该实例表示由此IRange表示的单元格或范围的单元格边框。

    • getInterior

      IInterior getInterior()
      返回表示指定单元格（们）内部（背景）颜色和图案的IInterior。

    • getNumberFormat

      String getNumberFormat()
      获取范围内单元格的数字格式。

    • setNumberFormat

      void setNumberFormat(String value)
      设置范围内单元格的数字格式。

    • getAddIndent

      boolean getAddIndent()
      获取属性，该属性控制在水平或垂直对齐设置为分布时文本的缩进。

    • setAddIndent

      void setAddIndent(boolean value)
      设置属性，控制在水平或垂直对齐设置为分布时文本的缩进。

    • getIndentLevel

      int getIndentLevel()
      获取指定单元格的缩进级别。

    • setIndentLevel

      void setIndentLevel(int value)
      设置指定单元格的缩进级别。

    • getHidden

      boolean getHidden()
      获取指定是否应隐藏行或列的属性。

    • setHidden

      void setHidden(boolean value)
      设置属性，以指定应隐藏行还是列。

    • getLocked

      boolean getLocked()
      获取指定单元格是否应被锁定的属性。

    • setLocked

      void setLocked(boolean value)
      设置属性，以指定单元格是否应被锁定。

    • getOrientation

      int getOrientation()
      获取单元格或区域中的文本方向，可能是从-90到90度，或者是255（垂直文本）。

    • setOrientation

      void setOrientation(int value)
      设置单元格或单元格范围中的文本方向，可以是-90到90度，或者是255（垂直文本）。

    • getShrinkToFit

      boolean getShrinkToFit()
      获取属性，该属性指定如果需要显示单元格内容，是否将以较小的字体绘制单元格。

    • setShrinkToFit

      void setShrinkToFit(boolean value)
      设置属性，指定如果需要显示单元格内容时是否以较小的字体绘制单元格。

    • getWrapText

      boolean getWrapText()
      获取一个标志，表示单元格中是否启用了自动换行。

    • setWrapText

      void setWrapText(boolean value)
      设置标志，该属性指示单元格中是否启用了自动换行。

    • getHorizontalAlignment

      HorizontalAlignment getHorizontalAlignment()
      获取单元格或单元格范围的HorizontalAlignment。

    • setHorizontalAlignment

      void setHorizontalAlignment(HorizontalAlignment value)
      设置单元格或单元格范围的HorizontalAlignment。

    • getVerticalAlignment

      VerticalAlignment getVerticalAlignment()
      获取单元格或单元格范围内的VerticalAlignment。

    • setVerticalAlignment

      void setVerticalAlignment(VerticalAlignment value)
      设置单元格或单元格范围的 VerticalAlignment。

    • getDisplayFormat

      IDisplayFormat getDisplayFormat()
      获取一个DisplayFormat对象，该对象表示指定范围的显示设置。

    • getFormulaHidden

      boolean getFormulaHidden()
      获取或设置当工作表受保护时公式是否隐藏。

    • setFormulaHidden

      void setFormulaHidden(boolean value)
      设置当工作表受保护时公式是否隐藏。

    • getReadingOrder

      ReadingOrder getReadingOrder()
      获取或设置指定对象的阅读顺序。

    • setReadingOrder

      void setReadingOrder(ReadingOrder value)
      设置指定对象的阅读顺序。

    • getStyle

      IStyle getStyle()
      获取与此IRange所代表的单元格相关联的名为IStyle的样式。

    • setStyle

      void setStyle(IStyle value)
      设置与此 IRnage 表示的单元格相关联的命名样式 IStyle。

    • getValidation

      IValidation getValidation()
      返回一个IValidation实例，可用于获取和设置由此IRange表示的单元格的验证属性。
    • IHyperlinks getHyperlinks()
      返回一个IValidation实例，可用于获取和设置超链接属性。

    • getComment

      IComment getComment()
      返回一个IComment实例，可用于获取和设置单元格的注释属性。

    • getSparklineGroups

      ISparklineGroups getSparklineGroups()
      返回一个ISparklineGroups实例，该实例可用于获取和设置单元格的SparklineGroups属性。

    • getWorksheet

      IWorksheet getWorksheet()
      返回此范围所属的父级 IWorksheet。

    • getEntireRow

      IRange getEntireRow()
      返回一个新实例的IRange，它表示同一范围内的单元格，但扩展到包括所有列。

    • getEntireColumn

      IRange getEntireColumn()
      返回一个新实例的IRange，它表示同一范围的单元格，但扩展到包括所有行。

    • getEntireMergeArea

      IRange getEntireMergeArea()
      返回一个IRange，表示当前范围区域，在迭代增长时直到不再包含任何部分合并的单元格。

    • getMergeArea

      IRange getMergeArea()
      返回一个表示包含指定单元格的合并范围的IRange。如果指定单元格不在合并范围内，此属性返回指定单元格。

    • getFormula

      String getFormula()
      获取此范围所表示的单元格的公式，以A1样式表示法。

    • setFormula

      void setFormula(String value)
      设置此范围所表示的单元格的公式，使用A1样式表示法。

    • getFormulaLocal

      String getFormulaLocal()
      获取此范围所表示的单元格的本地方案的A1样式表示法。

    • setFormulaLocal

      void setFormulaLocal(String value)
      设置以此范围表示的单元格的本地方案的公式，使用A1样式表示法。

    • getFormulaR1C1

      String getFormulaR1C1()
      获取此范围所表示的单元格的公式，以R1C1格式表示。

    • setFormulaR1C1

      void setFormulaR1C1(String value)
      设置此范围所表示的单元格的公式，使用R1C1格式表示法。

    • getFormulaR1C1Local

      String getFormulaR1C1Local()
      获取此范围所表示的单元格的本地化公式，以R1C1格式表示。

    • setFormulaR1C1Local

      void setFormulaR1C1Local(String value)
      设置此范围所表示的单元格的本地化公式，使用R1C1样式表示法。

    • getFormula2

      String getFormula2()
      获取此范围所表示的单元格在A1样式数组表示法中的公式。

    • setFormula2

      void setFormula2(String value)
      设置此范围所表示的单元格的公式，使用A1样式的数组表示法。

    • getFormula2Local

      String getFormula2Local()
      获取此范围所代表的单元格的本地化公式，以A1样式数组表示法表示。

    • setFormula2Local

      void setFormula2Local(String value)
      设置以此范围表示的单元格的本地方案的公式，采用A1样式数组表示法。

    • getFormula2R1C1

      String getFormula2R1C1()
      获取此范围所表示的单元格在R1C1样式数组表示法中的公式。

    • setFormula2R1C1

      void setFormula2R1C1(String value)
      设置此范围所代表的单元格的公式，使用R1C1样式的数组表示法。

    • getFormula2R1C1Local

      String getFormula2R1C1Local()
      获取此范围所代表的单元格在R1C1样式数组表示法中的本地化公式。

    • setFormula2R1C1Local

      void setFormula2R1C1Local(String value)
      设置此范围所表示的单元格的本地化公式，使用R1C1样式的数组表示法。

    • getFormulaArray

      String getFormulaArray()
      获取一个区域的数组公式。

    • setFormulaArray

      void setFormulaArray(String value)
      设置一个区域的数组公式。

    • getFormulaArrayR1C1

      String getFormulaArrayR1C1()
      获取使用ReferenceStyle.R1C1的范围的数组公式。

    • setFormulaArrayR1C1

      void setFormulaArrayR1C1(String value)
      设置一个区域的数组公式，使用 ReferenceStyle.R1C1。

    • getCurrentArray

      IRange getCurrentArray()
      获取指定单元格是否为数组的一部分，返回一个代表整个数组的 IRange 对象。

    • getHasFormula

      boolean getHasFormula()
      返回true如果单元格或范围包含任何公式；否则，返回false。

    • getHasArray

      boolean getHasArray()
      确定指定的单元格是否是数组公式的一部分。

    • getValue

      Object getValue()
      获取指定范围的值，作为一个字符串、双精度浮点数、布尔值、Date、Object[][] 或 null；

    • setValue

      void setValue(Object value)
      设置指定单元格的值，可以是字符串、双精度浮点数、整数、布尔值、Date、Calendar、Object[][] 或者 null。

    • setIgnoredError

      void setIgnoredError(EnumSet<IgnoredErrorType> value)
      设置要忽略的范围的错误类型。
      Parameters:
      value - IgnoredErrorType的EnumSet。

    • getIgnoredError

      EnumSet<IgnoredErrorType> getIgnoredError()
      获取要忽略的范围的错误类型。
      Returns:
      IgnoredErrorType 的 EnumSet。

    • getTag

      Object getTag()
      获取工作表中指定范围内的标签值。

    • setTag

      void setTag(Object value)
      设置工作表中指定范围内的标签值。

    • getCellType

      BaseCellType getCellType()
      获取工作表中指定范围内的单元格类型。

    • setCellType

      void setCellType(BaseCellType cellType)
      设置工作表中指定范围的单元格类型。

    • getBindingPath

      String getBindingPath()
      获取当前单元格或列的绑定路径。如果范围是正常范围，则返回范围左上角单元格的绑定路径。如果范围是整列（EntireColumn），则返回范围的左侧列绑定路径。如果范围是整行（EntireRow），则返回 null。

    • setBindingPath

      void setBindingPath(String value)
      设置当前单元格或列的绑定路径。如果范围是正常范围，则设置范围左上角单元格的绑定路径。如果范围是整列（EntireColumn），则设置范围左侧列的绑定路径。如果范围是整行（EntireRow），则不执行任何操作。

    • getText

      String getText()
      获取由此IRange表示的单元格的格式化字符串值。

    • getAreas

      IAreas getAreas()
      返回一个IAreas实例，该实例表示一系列范围，其中areas返回的每个范围代表一个单元格或区域。

    • getUsedRange

      IRange getUsedRange()
      返回一个IRange，表示当前范围内的使用范围。

    • getUsedRange

      IRange getUsedRange(EnumSet<UsedRangeType> type)
      返回一个IRange，代表当前范围内的使用范围。
      Parameters:
      type - 特征类型。

    • get

      IRange get(int rowOffset, int columnOffset)
      返回一个新实例的IRange，它是从此范围偏移的。
      Parameters:
      rowOffset - 行偏移量。
      columnOffset - 列偏移量。
      Returns:
      IRange。

    • get

      IRange get(int index)
      返回一个基于索引代表单元格的新IRange实例。
      Parameters:
      index - 范围的索引。

    • getMergeCells

      boolean getMergeCells()
      获取指定单元格是否合并的属性。

    • setMergeCells

      void setMergeCells(boolean value)
      设置属性，以指定是否合并单元格。

    • merge

      void merge()
      将所表示范围内的单元格合并为一个合并单元格。

    • merge

      void merge(boolean isAcross)
      合并表示范围内的单元格为一个合并后的单元格。
      Parameters:
      isAcross - 可选对象。设置为True以将指定范围内每行的单元格分别合并为单独的合并单元格。默认值为False。

    • unmerge

      void unmerge()
      将表示范围内合并的单元格转换为正常单元格。

    • insert

      void insert()
      在工作表中插入一个单元格或一系列单元格，并将其他单元格移开以腾出空间。

    • insert

      void insert(InsertShiftDirection shiftDirection)
      插入一个单元格或一系列单元格到工作表中，并移动其他单元格以腾出空间。
      Parameters:
      shiftDirection - 指定移动单元格的方向。

    • delete

      void delete()
      从工作表中删除一个单元格或一系列单元格，并将其他单元格移动以填充被删除的单元格。

    • delete

      void delete(DeleteShiftDirection shiftDirection)
      删除工作表中的单元格或单元格范围，并将其他单元格移动以替换被删除的单元格。
      Parameters:
      shiftDirection - 指定移动单元格的方向。

    • clear

      void clear()
      清除当前区域中的公式、值以及所有格式。

    • clearContents

      void clearContents()
      清除当前范围内的公式和值。

    • clearFormats

      void clearFormats()
      清除当前范围内的所有格式。
    • void clearHyperlinks()
      清除当前范围内的所有超链接。

    • clearComments

      void clearComments()
      清除当前范围内的注释。

    • clearCommentsThreaded

      void clearCommentsThreaded()
      清除当前范围内的线程化评论。

    • addComment

      IComment addComment(String text)
      添加注释到当前范围。
      Parameters:
      text - 您想要添加的文本。

    • sort

      void sort(SortOrientation orientation, boolean caseSensitive, IValueSortField... keys)
      根据指定的选项，对由此范围表示的单元格进行排序。
      Parameters:
      orientation - 排序方向。
      caseSensitive - 如果设置为true，区分大小写。
      keys - IValueSortField 数组。

    • sort

      void sort(IRange key, SortOrder order, SortOrientation orientation, boolean caseSensitive)
      根据指定的选项对由该范围表示的单元格进行排序。
      Parameters:
      key - 排序列的键。
      order - 排序顺序，升序或降序
      orientation - 方向。
      caseSensitive - 如果设置为true，则区分大小写。

    • sort

      void sort(IRange key, SortOrder order, SortOrientation orientation)
      根据指定的选项对由此范围表示的单元格进行排序。
      Parameters:
      key - 排序列的键。
      order - 排序顺序，升序或降序
      orientation - 排序方向。

    • autoFilter

      void autoFilter(int field, Object criteria1, AutoFilterOperator op, Object criteria2, boolean visibleDropDown)
      使用自动筛选过滤列表。
      Parameters:
      field - 可选对象。您希望基于其筛选的字段在列表中的整数偏移量（从列表左侧开始；最左边的字段是字段零）。
      criteria1 - 可选对象。条件（一个字符串；例如，“101”）。使用“=”来查找空白字段，或者使用“<>”来查找非空白字段。如果省略此参数，条件为全部。如果操作符为xlTop10Items，则Criteria1指定项目数量（例如，“10”）。
      op - 可选的自动筛选操作符
      criteria2 - 可选对象。第二个条件（一个字符串）。与Criteria1和Operator一起用来构建复合条件。
      visibleDropDown - 可选对象。为过滤字段显示自动筛选下拉箭头时为True；隐藏自动筛选下拉箭头时为False。默认为True。

    • autoFilter

      void autoFilter(int field)
      使用AutoFilter过滤列表。
      Parameters:
      field - 可选对象。您希望基于进行过滤的字段的整数偏移量（从列表左侧开始；最左边的字段是字段零）。

    • autoFilter

      void autoFilter()
      使用自动筛选器过滤列表。
      如果工作表中没有筛选器，则添加一个无条件筛选器。
      或者显示筛选器第一列中的所有数据。

    • autoFilter

      void autoFilter(int field, Object criteria1)
      使用AutoFilter过滤列表。
      Parameters:
      field - 可选对象。您希望基于过滤的字段在列表中的整数偏移量（从列表左侧开始；最左边的字段是字段零）。
      criteria1 - 可选对象。条件（一个字符串；例如，“101”）。使用“=”查找空白字段，或者使用“<>”查找非空白字段。如果省略此参数，条件为全部。如果操作符是xlTop10Items，则Criteria1指定项目数量（例如“10”）。

    • autoFilter

      void autoFilter(int field, Object criteria1, AutoFilterOperator op)
      使用自动筛选过滤列表。
      Parameters:
      field - 可选对象。您希望基于进行筛选的字段在列表中的整数偏移量（从列表左侧开始；最左边的字段是字段零）。
      criteria1 - 可选对象。筛选条件（一个字符串；例如，“101”）。使用“=”查找空白字段，或者使用“<>”查找非空白字段。如果省略此参数，则条件为全部。如果操作符是xlTop10Items，则Criteria1指定项目数量（例如，“10”）。
      op - 可选的自动筛选操作符

    • autoFilter

      void autoFilter(int field, Object criteria1, AutoFilterOperator op, Object criteria2)
      使用自动筛选过滤列表。
      Parameters:
      field - 可选对象。您希望基于进行筛选的字段在列表中的整数偏移量（从列表左侧开始；最左边的字段是字段零）。
      criteria1 - 可选对象。条件（一个字符串；例如，“101”）。使用“=”查找空白字段，或者使用“<>”查找非空白字段。如果省略此参数，则条件是全部。如果操作符是xlTop10Items，则Criteria1指定项目数（例如，“10”）。
      op - 可选的自动筛选操作符
      criteria2 - 可选对象。第二个条件（一个字符串）。与Criteria1和Operator一起用来构建复合条件。

    • autoFilter

      void autoFilter(boolean isFirstRowData, int field, Object criteria1, AutoFilterOperator op, Object criteria2, boolean visibleDropDown)
      使用AutoFilter过滤列表。
      Parameters:
      isFirstRowData - 指示选择区域的第一行是否参与过滤。设置为true时，行为与SpreadJS一致；为false时，与Microsoft Excel一致。
      field - 可选对象。您想基于其进行过滤的字段的整数偏移量（从列表左侧开始；最左边的字段为零）。
      criteria1 - 可选对象。条件（一个字符串，例如"101"）。使用"="来查找空白字段，或者使用" <>"来查找非空白字段。如果省略此参数，条件为全部。如果操作符是xlTop10Items，Criteria1指定项目数（例如"10"）。
      op - 可选的AutoFilter操作符
      criteria2 - 可选对象。第二个条件（一个字符串）。与Criteria1和Operator一起用来构建复合条件。
      visibleDropDown - 可选对象。为true时显示过滤字段的AutoFilter下拉箭头；为false时隐藏过滤字段的AutoFilter下拉箭头。默认为true。

    • autoFilter

      void autoFilter(boolean isFirstRowData)
      使用AutoFilter过滤列表。
      如果工作表中没有过滤器，则添加一个无条件过滤器。
      或者显示过滤器第一列中的所有数据。
      Parameters:
      isFirstRowData - 指示选择区域的第一行是否参与过滤。设置为true时，行为与SpreadJS一致；设置为false时，与Microsoft Excel一致。

    • autoFilter

      void autoFilter(boolean isFirstRowData, int field)
      使用AutoFilter过滤列表。
      Parameters:
      isFirstRowData - 指示选择区域的第一行是否参与过滤。设置为true时，行为与SpreadJS一致；为false时，与Microsoft Excel一致。
      field - 可选对象。基于过滤的字段在列表中的整数偏移量（从列表左侧开始；最左边的字段为零）。

    • autoFilter

      void autoFilter(boolean isFirstRowData, int field, Object criteria1)
      使用AutoFilter过滤列表。
      Parameters:
      isFirstRowData - 指示选择区域的第一行是否参与过滤。设置为true时，行为与SpreadJS一致；为false时，与Microsoft Excel一致。
      field - 可选对象。您希望基于过滤的字段在列表中的整数偏移量（从左侧开始；最左边的字段为零）。
      criteria1 - 可选对象。条件（一个字符串；例如"101"）。使用"="来查找空白字段，或者使用"<>"来查找非空白字段。如果省略此参数，条件为全部。如果操作符是xlTop10Items，Criteria1指定项目数量（例如"10"）。

    • autoFilter

      void autoFilter(boolean isFirstRowData, int field, Object criteria1, AutoFilterOperator op)
      使用AutoFilter过滤列表。
      Parameters:
      isFirstRowData - 指示选择区域的第一行是否参与过滤。设置为true时，行为与SpreadJS一致；设置为false时，与Microsoft Excel一致。
      field - 可选对象。您想要基于过滤的字段的整数偏移量（从列表左侧开始；最左边的字段是零号字段）。
      criteria1 - 可选对象。条件（一个字符串，例如"101"）。使用"="查找空白字段，或使用"<>"查找非空白字段。如果省略此参数，条件为全部。如果操作符是xlTop10Items，则Criteria1指定项目数量（例如"10"）。
      op - 可选的AutoFilter操作符

    • autoFilter

      void autoFilter(boolean isFirstRowData, int field, Object criteria1, AutoFilterOperator op, Object criteria2)
      使用自动筛选过滤列表。
      Parameters:
      isFirstRowData - 指示选择区域的第一行是否参与过滤。设置为true时，行为与SpreadJS一致；为false时，与Microsoft Excel一致。
      field - 可选对象。您希望基于过滤的字段的整数偏移量（从列表左侧开始；最左边的字段是字段零）。
      criteria1 - 可选对象。条件（一个字符串，例如“101”）。使用“=”来查找空白字段，或者使用“<>”来查找非空白字段。如果省略此参数，条件为全部。如果操作符是xlTop10Items，Criteria1指定项目数量（例如“10”）。
      op - 可选的AutoFilterOperator
      criteria2 - 可选对象。第二个条件（一个字符串）。与Criteria1和操作符一起用来构建复合条件。

    • getWidth

      double getWidth()
      获取范围的大小，以点为单位。

    • getWidthInPixel

      double getWidthInPixel()
      获取范围的宽度（以像素为单位）。

    • getColumnWidth

      double getColumnWidth()
      获取该范围内各个列的宽度（以字符为单位）。

    • setColumnWidth

      void setColumnWidth(double value)
      设置此范围内所表示的各个列的宽度（以字符为单位）。

    • getColumnWidthInPixel

      double getColumnWidthInPixel()
      获取此范围内表示的各个列的宽度（以像素为单位）。

    • setColumnWidthInPixel

      void setColumnWidthInPixel(double value)
      设置此范围内所代表各列的宽度（以像素为单位）。

    • getHeight

      double getHeight()
      获取范围内的点高度。

    • getHeightInPixel

      double getHeightInPixel()
      获取范围的高度，以像素为单位。

    • getRowHeight

      double getRowHeight()
      获取此范围所表示的各个行的身高（以点为单位）。

    • setRowHeight

      void setRowHeight(double value)
      设置此范围内代表的单个行的高度（以磅为单位）。

    • getRowHeightInPixel

      double getRowHeightInPixel()
      获取此范围所代表单个行的高度（以像素为单位）。

    • setRowHeightInPixel

      void setRowHeightInPixel(double value)
      设置此范围所代表的单个行的高度（以像素为单位）。

    • getFormatConditions

      IFormatConditions getFormatConditions()
      返回一个代表指定范围的所有条件格式的 FormatConditions 集合。

    • clearOutline

      void clearOutline()
      清除指定范围的轮廓。

    • group

      void group()
      增加指定行或列的轮廓级别。

    • ungroup

      void ungroup()
      减少指定行或列的大纲级别。

    • getOutlineLevel

      int getOutlineLevel()
      获取指定行或列的当前大纲级别。

    • setOutlineLevel

      void setOutlineLevel(int value)
      设置指定行或列的当前大纲级别。

    • getShowDetail

      boolean getShowDetail()
      获取是否显示详细信息（如果为指定范围展开大纲，则列或行的详细信息可见，则为True）。指定范围必须是大纲中的一个单一汇总列或行。

      以下陈述是正确的：1.范围必须位于单一的汇总行或列中。2.如果行或列的任何子项被隐藏，此属性将返回False。3.将此属性设置为True等同于显示汇总行或列的所有子项。4.将此属性设置为False等同于隐藏汇总行或列的所有子项。

    • setShowDetail

      void setShowDetail(boolean value)
      设置是否显示详细信息（如果为指定范围展开大纲，则列或行的详细信息可见，则为True）。指定范围必须是大纲中的一个单一汇总列或行。

      以下陈述是正确的：1.范围必须位于单个汇总行或列中。2.如果行或列的任何子项被隐藏，则此属性返回False。3.将此属性设置为True等效于取消隐藏汇总行或列的所有子项。4.将此属性设置为False等效于隐藏汇总行或列的所有子项。

    • getSummary

      boolean getSummary()
      确定该范围是否为大纲摘要行或列。

    • activate

      void activate()
      激活单个单元格，该单元格必须位于当前选定区域内。

    • select

      void select()
      选择对象。

    • copy

      void copy(IRange destination)
      复制范围到指定的范围。

    • copy

      @Deprecated void copy(IRange destination, EnumSet<PasteType> pasteType)
      Deprecated.
      此方法不再适用于计算版本间的时间。

      请改用 copy(IRange,PasteOption)。

      复制指定范围到特定范围。
      Parameters:
      destination - 指定要粘贴指定范围的新范围。它可以是同一工作簿或另一个工作簿的范围。
      pasteType - 指定要粘贴范围的部分。

    • copy

      void copy(IRange destination, PasteOption pasteOption)
      复制指定范围到特定范围。
      Parameters:
      destination - 指定要粘贴指定范围的新范围。它可以是同一工作簿或另一个工作簿的范围。
      pasteOption - 指定要粘贴的范围部分以及是否包含隐藏范围。

    • cut

      void cut(IRange destination)
      裁剪指定范围到指定的范围。
      Parameters:
      destination - 指定要将指定范围粘贴到的新范围。它可以是同一工作簿或另一个工作簿的范围。

    • getHasValidation

      boolean getHasValidation()
      返回true，如果此范围所代表的任何单元格都具有与之相关的数据验证。

    • getValidationIsSame

      boolean getValidationIsSame()
      返回 true 如果此 IRange 表示的所有单元格的验证选项相同；否则返回 false。

    • getUseStandardHeight

      boolean getUseStandardHeight()
      获取IRange对象的行高是否等于工作表的标准高度。

    • setUseStandardHeight

      void setUseStandardHeight(boolean value)
      设置IRange对象的行高是否等于工作表的标准高度。

    • getUseStandardWidth

      boolean getUseStandardWidth()
      获取IRange对象的列宽是否等于工作表的标准宽度。

    • setUseStandardWidth

      void setUseStandardWidth(boolean value)
      设置IRange对象的列宽是否等于工作表的标准宽度。

    • calculate

      void calculate()
      计算所需的范围公式。

    • dirty

      void dirty()
      指定在下次计算发生时，重新计算范围内所有公式。

    • isRichText

      boolean isRichText()
      表示单元格字符串值是否为富文本。

    • getRichText

      IRichText getRichText()
      获取与此范围左上角单元格关联的富文本对象。

    • characters

      ITextRun characters(int startIndex, int length)
      返回一个代表单元格文本中字符范围的ITextRun对象。

    • find

      IRange find(Object what, IRange after, FindOptions options)
      查找指定范围内的特定信息。
      Parameters:
      what - 要搜索的数据。可以是字符串、双精度浮点数、日期、日历、布尔值或整数。
      after - 您希望搜索开始的单元格之后的单元格。这对应于从用户界面进行搜索时的活动单元格位置。请注意，After必须是范围内的单个单元格。请记住，搜索是从这个单元格之后开始的；直到方法绕回这个单元格，指定单元格才被搜索。如果您没有指定此参数，当FindOptions.SearchDirection为SearchDirection.Next时，搜索将从范围内的左上角单元格开始，或者当FindOptions.SearchDirection为SearchDirection.Previous时，从右下角单元格开始。
      options - 查找选项
      Returns:
      表示找到该信息的第一个单元格的IRange对象。

    • find

      IRange find(Object what, IRange after)
      查找指定范围内的特定信息。
      Parameters:
      what - 要搜索的数据。可以是String、double、Date、LocalDateTime、Calendar、boolean或int。
      after - 您希望搜索开始的单元格之后的单元格。这对应于从用户界面进行搜索时活动单元格的位置。请注意，After必须是范围内的单个单元格。请记住，搜索是从这个单元格之后开始的；直到方法回绕到这个单元格，指定单元格才被搜索。如果您没有指定此参数，当FindOptions.SearchDirection为SearchDirection.Next时，搜索将从范围左上角的单元格开始，或者当FindOptions.SearchDirection为SearchDirection.Previous时，从范围右下角的单元格开始。
      Returns:
      表示找到该信息的第一个单元格的IRange对象。

    • find

      IRange find(Object what)
      在指定范围内查找特定信息，从左上角开始。
      Parameters:
      what - 要搜索的数据。可以是String、double、Date、LocalDateTime、Calendar、boolean或int。
      Returns:
      一个表示找到该信息的第一个单元格的IRange对象。

    • find

      IRange find(Object what, FindOptions options)
      在指定范围内查找特定信息，从左上角开始。
      Parameters:
      what - 要搜索的数据。可以是String、double、Date、LocalDateTime、Calendar、boolean或int。
      options - 查找选项
      Returns:
      表示找到该信息的第一个单元格的IRange对象。

    • replace

      int replace(Object what, Object replacement)
      在公式中搜索并替换。使用此方法不会改变选择或活动单元格。
      Parameters:
      what - 要搜索的字符串。
      replacement - 要替换的字符串。
      Returns:
      被替换的单元格数量。

    • replace

      int replace(Object what, Object replacement, ReplaceOptions options)
      在公式中搜索并替换。使用此方法不会改变选择或活动单元格。
      Parameters:
      what - 要搜索的字符串。
      replacement - 要替换的字符串。
      options - 替换选项。
      Returns:
      被替换的单元格数。

    • autoFit

      void autoFit()
      更改范围内列的宽度或行的高度以达到最佳适配。

    • autoFit

      void autoFit(boolean considerMergedCell)
      更改范围内列的宽度或行的高度以达到最佳匹配。
      Parameters:
      considerMergedCell - 指示是否考虑单行中的合并单元格。

    • subtotal

      void subtotal(int groupBy, ConsolidationFunction subtotalFunction, int[] totalList)
      为该范围创建小计。
      Parameters:
      groupBy - 分组的字段，作为一个基于1的整数偏移量。
      subtotalFunction - 小计函数。
      totalList - 一个基于1的字段偏移量数组，表示添加小计的字段。

    • subtotal

      void subtotal(int groupBy, ConsolidationFunction subtotalFunction, int[] totalList, boolean replace)
      为该范围创建小计。
      Parameters:
      groupBy - 分组的字段，作为一个基于1的整数偏移量。
      subtotalFunction - 小计函数。
      totalList - 一个基于1的字段偏移量数组，表示将小计添加到的字段。
      replace - 如果为True，则替换现有小计。默认值为True。

    • subtotal

      void subtotal(int groupBy, ConsolidationFunction subtotalFunction, int[] totalList, boolean replace, boolean pageBreaks)
      为该范围创建小计。
      Parameters:
      groupBy - 分组字段，基于一的位置整数偏移。
      subtotalFunction - 小计函数。
      totalList - 一个基于一的字段偏移数组，指明要添加小计的字段。
      replace - 如果为True，则替换现有小计。默认值为True。
      pageBreaks - 如果为True，则在每组后添加分页符。默认值为False。

    • subtotal

      void subtotal(int groupBy, ConsolidationFunction subtotalFunction, int[] totalList, SummaryRow summaryRowLocation)
      为该范围创建小计。
      Parameters:
      groupBy - 以一为基数的整数偏移量表示的分组字段。
      subtotalFunction - 小计函数。
      totalList - 一个以1为基数的字段偏移量数组，表示将小计添加到的字段。
      summaryRowLocation - 相对于小计放置汇总数据的位置。默认值为下方。

    • subtotal

      void subtotal(int groupBy, ConsolidationFunction subtotalFunction, int[] totalList, boolean replace, boolean pageBreaks, SummaryRow summaryRowLocation)
      为该范围创建小计。
      Parameters:
      groupBy - 分组的字段，作为一个基于1的整数偏移量。
      subtotalFunction - 小计函数。
      totalList - 一个基于1的字段偏移量数组，指明将小计添加到哪些字段。
      replace - 是否替换现有小计。默认值为True。
      pageBreaks - 是否在每个组后添加分页符。默认值为False。
      summaryRowLocation - 相对于小计放置汇总数据的位置。默认值为Below（下方）。

    • removeSubtotal

      void removeSubtotal()
      从列表中移除小计。

    • getPrecedents

      List<IRange> getPrecedents()
      获取范围左上单元格的前置范围。

    • getPrecedents

      List<IRange> getPrecedents(boolean includeInDirect)
      获取范围内所有单元格的前置范围。
      Parameters:
      includeInDirect - 指示是否包括间接前导的标志。

    • getDependents

      List<IRange> getDependents()
      获取范围左上单元格的依赖范围。

    • getDependents

      List<IRange> getDependents(boolean includeIndirect)
      获取范围内所有单元格的依赖范围。
      Parameters:
      includeIndirect - 是否包括间接依赖的单元格。

    • 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 - 输出图像的选项。

    • getAddress

      String getAddress()
      返回一个代表范围引用的字符串值。

    • getAddress

      String getAddress(boolean rowAbsolute, boolean columnAbsolute)
      返回一个代表范围引用的字符串值。
      Parameters:
      columnAbsolute - 如果要返回引用中列部分的绝对引用，则为true。默认值为true。
      rowAbsolute - 如果要返回引用中行部分的绝对引用，则为true。默认值为true。

    • getAddress

      String getAddress(boolean rowAbsolute, boolean columnAbsolute, ReferenceStyle referenceStyle)
      返回一个代表范围引用的字符串值。
      Parameters:
      columnAbsolute - 如果要返回引用中的列部分作为绝对引用，则为true。默认值为true。
      rowAbsolute - 如果要返回引用中的行部分作为绝对引用，则为true。默认值为true。
      referenceStyle - 引用样式。默认值为A1。

    • getAddress

      String getAddress(boolean rowAbsolute, boolean columnAbsolute, ReferenceStyle referenceStyle, IRange relativeTo)
      返回一个代表范围引用的字符串值。
      Parameters:
      columnAbsolute - 如果要返回引用中的列部分作为绝对引用，则设置为true。默认值为true。
      rowAbsolute - 如果要返回引用中的行部分作为绝对引用，则设置为true。默认值为true。
      referenceStyle - 引用样式。默认值为A1。
      relativeTo - 如果RowAbsolute和ColumnAbsolute均为false，且ReferenceStyle为R1C1，则定义相对引用的起始点。默认引用为$A$1。

    • specialCells

      IRange specialCells(SpecialCellType type)
      获取一个IRange对象，该对象表示与指定类型和值匹配的所有单元格。

    • specialCells

      IRange specialCells(SpecialCellType type, SpecialCellsValue value)
      获取一个IRange对象，该对象表示与指定类型和值匹配的所有单元格。

    • getCellPadding

      ICellPadding getCellPadding()
      获取范围的单元格边距。
      Returns:
      一个ICellPadding对象，仅限SpreadJS。

    • setCellPadding

      void setCellPadding(ICellPadding cellPadding)
      设置范围的单元格边距。
      Parameters:
      cellPadding - 仅适用于SpreadJS。

    • getWatermark

      String getWatermark()
      获取范围的水印。
      Returns:
      仅限SpreadJS的水印字符串。

    • setWatermark

      void setWatermark(String watermark)
      设置范围的水印。
      Parameters:
      watermark - 仅适用于SpreadJS。

    • getDecoration

      ICellDecoration getDecoration()
      获取范围的单元格装饰。仅适用于SpreadJS。
      Returns:
      单元格装饰。

    • setDecoration

      void setDecoration(ICellDecoration value)
      设置范围的单元格装饰。仅适用于SpreadJS。
      Parameters:
      value - 单元格装饰。

    • getLabelOptions

      ILabelOptions getLabelOptions()
      获取水印设置的选项。
      Returns:
      仅用于SpreadJS的 ILabelOptions 对象。

    • fromJson

      void fromJson(String json)
      生成从JSON字符串的范围数据。
      Parameters:
      json - 包含范围信息的JSON字符串。

    • toJson

      String toJson()
      生成一个包含范围信息的JSON字符串。
      Returns:
      包含范围信息的JSON字符串。

    • addCommentThreaded

      ICommentThreaded addCommentThreaded(String text)
      添加一个线程评论到该范围。
      Parameters:
      text - 线程评论的内容字符串。

    • addCommentThreaded

      ICommentThreaded addCommentThreaded(String text, String author)
      添加一个线程评论到该范围。
      Parameters:
      text - 评论内容字符串。
      author - 线程评论的作者名称。
      Returns:
      新增的线程评论。

    • getCommentThreaded

      ICommentThreaded getCommentThreaded()
      Returns:
      获取特定单元格的线程评论

    • generateGetPivotDataFunction

      String generateGetPivotDataFunction(IRange destination)
      生成对应于数据透视表中单元格的 "GETPIVOTDATA" 函数。
      Parameters:
      destination - 指示为哪个区域生成 "GETPIVOTDATA" 函数。
      Returns:
      "GETPIVOTDATA" 函数

    • generateGetPivotDataFunction

      String generateGetPivotDataFunction()
      生成对应的函数 "GETPIVOTDATA"，用于透视表中的单元格。
      Returns:
      "GETPIVOTDATA" 函数

    • intersect

      IRange intersect(IRange range2)
      返回一个代表多个范围相交的IRange对象。
      如果指定了来自不同工作表的一个或多个范围，则会抛出异常。
      Parameters:
      range2 - 相交的范围。
      Returns:
      一个新的范围，包含此范围与其他范围的相交部分，如果范围不相交则返回null。

    • intersect

      IRange intersect(IRange... ranges)
      返回一个代表多个范围相交的IRange对象。
      如果指定了来自不同工作表的一个或多个范围，则会抛出异常。
      Parameters:
      ranges - 相交的范围。
      Returns:
      一个新的范围，包含此范围与其他范围的相交部分，如果范围不相交则返回null。

    • union

      IRange union(IRange range2)
      返回一个表示多个范围并集的IRange对象。
      如果指定了来自不同工作表的一个或多个范围，将抛出异常。
      Parameters:
      range2 - 要与此范围联合的其他范围。
      Returns:
      一个新的范围，由此范围与其他范围的并集组成。

    • union

      IRange union(IRange... ranges)
      返回一个表示多个范围并集的IRange对象。
      如果指定了来自不同工作表的一个或多个范围，将抛出异常。
      Parameters:
      ranges - 要与此范围联合的其他范围。
      Returns:
      一个新的范围，由此范围与其他范围的并集组成。

    • offset

      IRange offset(int rowOffset, int columnOffset)
      返回一个表示此范围偏移量的IRange对象。
      Parameters:
      rowOffset - 行偏移量。
      columnOffset - 列偏移量。
      Returns:
      一个由此范围偏移量组成的新范围。

    • getDefaultValue

      Object getDefaultValue()
      获取单元格的默认值，它可以是值数据或公式字符串。当单元格没有数据时起作用。

    • setDefaultValue

      void setDefaultValue(Object value)
      设置单元格的默认值，可以是数值数据或公式字符串。当单元格没有数据时，它将起作用。

    • goalSeek

      boolean goalSeek(double goal, IRange changingCell)
      使用目标求解通过调整输入值来找到所需的结果。如果您知道想要从公式中得到的结果，但不确定公式需要什么输入值才能得到该结果，就可以使用目标求解功能。
      Parameters:
      goal - 期望的结果值
      changingCell - 要调整的单元格
      Returns:
      如果成功找到期望的结果值返回True，否则返回False。

    • getBackgroundImage

      byte[] getBackgroundImage()
      获取单元格背景图像。
      Returns:
      单元格背景图像的字节数组。

    • setBackgroundImage

      void setBackgroundImage(byte[] backgroundImage)
      设置单元格背景图像。支持图像类型包括：PNG、JPG、ICO、SVG、GIF。这只在SpreadJS中可见，以及导出为PDF/HTML/IMG时可见。
      Parameters:
      backgroundImage - 单元格背景图像的字节数组。

    • getBackgroundImageLayout

      BackgroundImageLayout getBackgroundImageLayout()
      获取单元格背景图像布局，默认为拉伸。
      Returns:
      单元格的背景图像布局。

    • setBackgroundImageLayout

      void setBackgroundImageLayout(BackgroundImageLayout backgroundImageLayout)
      设置单元格背景图片布局。
      Parameters:
      backgroundImageLayout - 单元格的背景图片布局。

    • importData

      DataImportResult importData(Object items)
      导入数据（最多二维）到指定范围。
      Parameters:
      items - 要导入的项目。元素类型可以是： 集合类型可以是：
      • 一维(非嵌套)的Iterable或数组。
      • 由嵌套数组构成的二维数组，其中内部集合的元素类型为基础或可为空的基础类型。
      Throws:
      ClassCastException - 列的数据类型不一致。使用DataImportOptions.setItemTypeProvider(java.util.function.Function<java.lang.Object, java.lang.Class<?>>)来修复它。
      IllegalArgumentException - 项目是不支持的类型或options包含错误信息。
      API Note:
      如果项目是原始类型的列表或数组，则方向由范围的形状确定。如果范围的行数大于列数，我们垂直导入集合。否则，我们水平导入集合。

    • importData

      DataImportResult importData(Object items, DataImportOptions options)
      导入数据（最多二维）到指定范围。
      Parameters:
      items - 要导入的项目。元素类型可以是： 集合类型可以是：
      • 一维(非嵌套)的Iterable或数组。
      • 由嵌套数组构成的二维数组，其中内部集合的元素类型为基础或可为空的基础类型。
      options - 导入选项。
      Throws:
      ClassCastException - 列的数据类型不一致。使用DataImportOptions.setItemTypeProvider(java.util.function.Function<java.lang.Object, java.lang.Class<?>>)来修复它。
      IllegalArgumentException - 项目是不支持的类型或options包含错误信息。
      API Note:
      如果项目是原始类型的列表或数组，则方向由范围的形状确定。如果范围的行数大于列数，我们垂直导入集合。否则，我们水平导入集合。