程序包 com.grapecity.documents.excel

接口 IWorkbook

所有已知实现类:
Workbook
public interface IWorkbook
代表一个IWorkbook对象。

  • 方法详细资料

    • getAfterSaveEvent

      Event<EventHandler<EventArgs>> getAfterSaveEvent()
      在工作簿保存之后发生。

    • getBeforeSaveEvent

      Event<EventHandler<EventArgs>> getBeforeSaveEvent()
      在工作簿保存之前发生。

    • getNewSheetEvent

      Event<EventHandler<SheetEventArgs>> getNewSheetEvent()
      发生在一个新的工作表在工作簿中被创建时。

    • getOpenedEvent

      Event<EventHandler<EventArgs>> getOpenedEvent()
      发生当工作簿被打开时。

    • getSheetActivateEvent

      Event<EventHandler<SheetEventArgs>> getSheetActivateEvent()
      当一个工作表被激活时发生。

    • getSheetBeforeDeleteEvent

      Event<EventHandler<SheetEventArgs>> getSheetBeforeDeleteEvent()
      在删除工作表之前发生。

    • getSheetChangeEvent

      Event<EventHandler<RangeEventArgs>> getSheetChangeEvent()
      当工作表的单元格内容发生变化时发生。

    • getSheetDeactivateEvent

      Event<EventHandler<SheetEventArgs>> getSheetDeactivateEvent()
      当工作表被停用时发生。

    • getSheetSelectionChange

      Event<EventHandler<RangeEventArgs>> getSheetSelectionChange()
      当工作表上的选择发生变化时发生。

    • getAllowDynamicArray

      @Deprecated boolean getAllowDynamicArray()
      已过时。
      获取是否允许动态数组公式。此方法已过时，请使用 getFormula2() 来获取动态数组公式。

    • setAllowDynamicArray

      @Deprecated void setAllowDynamicArray(boolean value)
      已过时。
      设置是否允许动态数组公式。此方法已过时，请使用 setFormula2() 来设置动态数组公式。

    • getDeferUpdateDirtyState

      boolean getDeferUpdateDirtyState()
      获取是否在更改单元格值时立即更新公式单元格的脏状态。

    • setDeferUpdateDirtyState

      void setDeferUpdateDirtyState(boolean value)
      设置当更改单元格的值时是否立即更新公式单元格的脏状态。

    • getName

      String getName()
      获取一个代表工作簿名称的字符串值。

    • setName

      void setName(String name)
      设置一个代表工作簿名称的字符串值。

    • getFullName

      String getFullName()
      返回工作簿的名称，包括其在磁盘上的路径。

    • getPath

      String getPath()
      获取一个字符串，该字符串表示此工作簿对象所代表的工作簿文件的路径。

    • setPath

      void setPath(String path)
      设置一个字符串，该字符串表示此工作簿对象所代表的工作簿文件的路径。

    • getSelectedSheets

      IWorksheets getSelectedSheets()
      返回一个 IWorksheets 集合，该集合代表指定工作簿中所有选中的工作表。

    • getOptions

      IExcelOptions getOptions()
      返回代表控制工作簿行为的某些设置的IExcelOptions对象。

    • getResetAdjacentRangeBorder

      boolean getResetAdjacentRangeBorder()
      确定在为范围设置边框时是否重置相邻范围的边框。此属性的默认值为true。

    • setResetAdjacentRangeBorder

      void setResetAdjacentRangeBorder(boolean value)
      确定在为范围设置边框时是否重置相邻范围的边框。此属性的默认值为 true。
      参数:
      value - 如果要重置相邻范围的边框，则为true；否则为false。

    • getAutoParse

      boolean getAutoParse()
      获取在将范围值设置为一个字符串值时是否自动解析。

    • setAutoParse

      void setAutoParse(boolean value)
      设置在将范围值设置为字符串值时是否自动解析。

    • getAutoRoundValue

      boolean getAutoRoundValue()
      获取值时是否将数字四舍五入到15位有效数字。

    • setAutoRoundValue

      void setAutoRoundValue(boolean value)
      设置在获取数值时是否将数字四舍五入到15位有效数字。

    • getBookView

      IWorkbookView getBookView()
      返回一个代表此工作簿视图设置的对象。

    • getProtectStructure

      boolean getProtectStructure()
      如果工作簿中工作表顺序受保护则为true。只读布尔值。

    • getProtectWindows

      boolean getProtectWindows()
      如果工作簿的窗口受到保护则为true。只读布尔值。

    • getSignatures

      ISignatureSet getSignatures()
      获取与文档附加的数字签名对应的签名对象集合。

    • getBuiltInDocumentProperties

      IBuiltInDocumentPropertyCollection getBuiltInDocumentProperties()
      获取一个代表工作簿所有内置文档属性的集合。

    • getCustomDocumentProperties

      ICustomDocumentPropertyCollection getCustomDocumentProperties()
      获取代表工作簿所有自定义文档属性的集合。

    • getCustomViews

      ICustomViews getCustomViews()
      获取工作簿的自定义视图。

    • getWriteProtection

      WriteProtection getWriteProtection()
      返回一个WriteProtection对象，该对象提供了访问工作簿写保护选项的权限。

    • getEnableCalculation

      boolean getEnableCalculation()
      获取计算引擎是否有效。

    • setEnableCalculation

      void setEnableCalculation(boolean value)
      设置计算引擎是否有效。

    • getCulture

      Locale getCulture()
      获取工作簿的文化信息。这将影响与文化相关的特性。

    • setCulture

      void setCulture(Locale value)
      为工作簿设置区域信息。这将影响到与文化相关的功能。区域信息必须同时包含国家/地区和语言。例如：

      区域信息必须同时包含国家和语言。例如：

      API Note:
      区域信息必须在工作簿实例的初始化代码中设置。

    • getDefaultTableStyle

      String getDefaultTableStyle()
      获取作为默认表格样式的 ITableStyleCollection 集合中的表格样式名称。

    • setDefaultTableStyle

      void setDefaultTableStyle(String value)
      设置表格样式名称，从作为默认TableStyle的ITableStyleCollection集合中使用。

    • getNames

      INames getNames()
      返回代表工作簿指定名称的INames集合。

    • getAuthor

      String getAuthor()
      获取作者。

    • setAuthor

      void setAuthor(String value)
      设置作者。

    • getPivotCaches

      IPivotCaches getPivotCaches()
      返回代表指定工作簿中所有IPivotTable缓存的IPivotCaches集合。

    • getReferenceStyle

      ReferenceStyle getReferenceStyle()
      获取引用样式。

    • setReferenceStyle

      void setReferenceStyle(ReferenceStyle value)
      设置引用样式。

    • getStyles

      IStyleCollection getStyles()
      返回代表指定工作簿中所有样式的 IStyleCollection 集合。

    • getTableStyles

      ITableStyleCollection getTableStyles()
      返回当前工作簿的ITableStyleCollection集合对象，该对象指的是当前工作簿中使用的样式。

    • getTheme

      ITheme getTheme()
      返回应用于当前工作簿的主题。

    • setTheme

      void setTheme(ITheme value)
      设置应用于当前工作簿的主题。

    • getIconSets

      IIconSets getIconSets()
      基于图标集中的一个单元格图标，过滤工作簿中的数据。

    • getWorksheets

      IWorksheets getWorksheets()
      返回代表指定工作簿中所有工作表的IWorksheets集合。这是一个只读的Sheets对象。

    • getActiveSheet

      IWorksheet getActiveSheet()
      返回一个表示活动工作簿（顶部的工作表）或指定窗口或工作簿中活动工作表的对象。如果没有活动的工作表，则返回 null。

    • getSlicerCaches

      ISlicerCaches getSlicerCaches()
      获取与工作簿关联的ISlicerCaches对象。

    • calculate

      void calculate()
      计算工作簿中所需的公式。

    • dirty

      void dirty()
      指定在下次计算发生时重新计算工作簿中的所有公式。

    • fromJson

      List<JsonError> fromJson(String json)
      从JSON字符串生成工作簿。
      参数:
      json - JSON字符串。
      返回:
      JSON中的错误。

    • fromJson

      List<JsonError> fromJson(String json, DeserializationOptions deserializationOptions)
      生成一个工作簿从JSON字符串。
      参数:
      json - json字符串。
      deserializationOptions - DeserializationOptions 对象。
      返回:
      json中的错误。

    • fromJson

      List<JsonError> fromJson(InputStream stream)
      从JSON流生成一个工作簿。
      参数:
      stream - 流
      返回:
      JSON中的错误。

    • fromJson

      List<JsonError> fromJson(InputStream stream, DeserializationOptions deserializationOptions)
      从JSON流生成工作簿。
      参数:
      stream - 流
      deserializationOptions - DeserializationOptions对象。
      返回:
      JSON中的错误。

    • toJson

      String toJson()
      生成一个工作簿的JSON字符串。
      返回:
      JSON字符串。

    • toJson

      String toJson(SerializationOptions serializationOptions)
      生成一个从工作簿转换而来的JSON字符串。
      参数:
      serializationOptions - SerializationOptions对象。
      返回:
      JSON字符串。

    • toJson

      void toJson(OutputStream stream)
      从工作簿生成一个JSON流。
      参数:
      stream - 输出流。

    • toJson

      void toJson(OutputStream stream, SerializationOptions serializationOptions)
      生成一个工作簿的JSON流。
      参数:
      stream - 输出流。
      serializationOptions - SerializationOptions对象。

    • isEncryptedFile

      boolean isEncryptedFile(String fileName)
      指定文件是否受密码保护。
      参数:
      fileName - 文件名。

    • isEncryptedFile

      boolean isEncryptedFile(InputStream fileStream)
      指定文件是否受密码保护。
      参数:
      fileStream - 输入文件流。

    • open

      void open(String fileName)
      打开指定的Excel文件
      参数:
      fileName - Excel文件。

    • open

      List<JsonError> open(String fileName, DeserializationOptions deserializationOptions)
      打开JSON文件。
      参数:
      fileName - 指定的json文件。
      deserializationOptions - JSON反序列化选项。
      返回:
      Json错误

    • open

      void open(String fileName, String password)
      打开指定的Excel文件
      参数:
      fileName - Excel文件。
      password - 文件的密码。

    • open

      void open(String fileName, OpenOptionsBase options)
      打开具有指定选项的文件。
      参数:
      fileName - Excel文件。
      options - 打开文件的选项。可能的类型：

    • open

      void open(String fileName, OpenFileFormat fileFormat)
      打开指定格式的文件。
      参数:
      fileName - 指定的文件。
      fileFormat - 文件的格式。

    • open

      void open(InputStream fileStream)
      打开指定的Excel文件流。
      参数:
      fileStream - 文件流。

    • open

      void open(InputStream fileStream, String password)
      打开指定的Excel文件流。
      参数:
      fileStream - 文件流。
      password - 文件的密码。

    • open

      void open(InputStream fileStream, OpenOptionsBase options)
      打开具有指定选项的流。
      参数:
      fileStream - 文件流。
      options - 打开文件流的格式。可能的类型：

    • open

      void open(InputStream fileStream, OpenFileFormat fileFormat)
      打开指定的格式文件流。
      参数:
      fileStream - 指定的文件流。
      fileFormat - 文件流的格式。

    • save

      void save(String fileName)
      保存工作簿到磁盘。
      参数:
      fileName - 文件名。

    • save

      void save(String fileName, String password)
      保存数据到指定的Excel文件。
      参数:
      fileName - Excel文件。
      password - 文件的密码。

    • save

      void save(String fileName, SaveOptionsBase options)
      将工作簿保存到具有指定选项的文件。
      参数:
      fileName - 指定的文件。
      options - 保存文件的选项。可能的类型：

    • save

      void save(String fileName, SaveFileFormat fileFormat)
      保存指定格式的文件。
      参数:
      fileName - 指定的文件。
      fileFormat - 文件的格式。

    • save

      void save(OutputStream outputStream)
      保存工作簿到流中。
      参数:
      outputStream - 文件流。

    • save

      void save(OutputStream outputStream, String password)
      将数据保存到指定的Excel文件流。
      参数:
      outputStream - 文件流。
      password - 文件的密码。

    • save

      void save(OutputStream fileStream, SaveOptionsBase options)
      将工作簿保存到具有指定选项的流中。
      参数:
      fileStream - 指定的文件流。
      options - 保存文件流的选项。可能的类型：

    • save

      void save(OutputStream fileStream, SaveFileFormat fileFormat)
      保存指定格式的文件流。
      参数:
      fileStream - 指定的文件流。
      fileFormat - 文件流的格式。

    • getUsedFonts

      List<FontInfo> getUsedFonts()
      获取工作簿上所使用的所有字体信息。

    • protect

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

    • protect

      void protect(boolean structure)
      保护工作簿，使其不能被修改。
      参数:
      structure - 如果设置为true，则保护工作簿的结构（防止其他用户查看隐藏的工作表、添加、移动、删除或隐藏工作表，以及重命名工作表）。

    • protect

      void protect(boolean structure, boolean windows)
      保护工作簿，使其不能被修改。
      参数:
      structure - 如果为true，则保护工作簿的结构（防止其他用户查看隐藏的工作表、添加、移动、删除或隐藏工作表，以及重命名工作表）。
      windows - 如果为true，防止用户移动、调整大小或关闭工作簿窗口，或隐藏/显示窗口。此选项仅在Excel 2007、Excel 2010、Excel for Mac 2011和Excel 2016 for Mac中可用。

    • protect

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

    • protect

      void protect(String password, boolean structure)
      保护工作簿，使其不能被修改。
      参数:
      password - 用于保护工作簿的密码。
      structure - 如果设置为true，则保护工作簿的结构（防止其他用户查看隐藏的工作表、添加、移动、删除或隐藏工作表，以及重命名工作表）。

    • protect

      void protect(String password, boolean structure, boolean windows)
      保护工作簿，使其不能被修改。
      参数:
      password - 用于保护工作簿的密码。
      structure - 如果设置为true，则保护工作簿的结构（防止其他用户查看隐藏的工作表、添加、移动、删除或隐藏工作表，以及重命名工作表）。
      windows - 如果设置为true，则阻止用户移动、调整大小或关闭工作簿窗口，或隐藏/显示窗口。此选项仅在 Excel 2007、Excel 2010、Excel for Mac 2011 和 Excel 2016 for Mac 中可用。

    • unprotect

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

    • unprotect

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

    • addDataSource

      void addDataSource(String name, Object dataSource)
      添加模板的数据源
      参数:
      name - : 数据源的别名
      dataSource - : 可以是ResultSet对象、自定义对象和变量。

    • processTemplate

      void processTemplate()
      开始处理模板。

    • processTemplate

      void processTemplate(CancellationToken cancellationToken)
      开始使用全局选项和取消支持处理模板。
      API Note:
      调用者必须决定是接受部分展开的模板还是恢复到之前的状态。如果调用者需要恢复到之前的状态，那么在调用此方法之前必须序列化工作簿，然后在取消操作后反序列化工作簿。
      参数:
      cancellationToken - 用于监控取消请求的令牌。
      抛出:
      CancellationException - 当CancellationToken被取消时抛出。

    • generateReport

      IWorkbook generateReport()
      处理模板并返回报告工作簿的实例。
      返回:
      新的 IWorkbook 对象。

    • generateReport

      IWorkbook generateReport(IWorksheet... worksheets)
      处理模板并返回报表工作簿实例。
      参数:
      worksheets - 需要处理的工作表集合。
      返回:
      新的 IWorkbook 对象。

    • getGraphicsInfo

      IGraphicsInfo getGraphicsInfo()
      提供图形信息。如果此属性没有值，工作簿将使用内置的图形信息。

    • setGraphicsInfo

      void setGraphicsInfo(IGraphicsInfo value)
      提供图形信息。如果此属性没有值，工作簿将使用内置的图形信息。

    • getExcelLinkSources

      List<String> getExcelLinkSources()
      返回关联的Excel文档的名称。

    • updateExcelLink

      void updateExcelLink(String name)
      更新Excel链接。

    • updateExcelLink

      void updateExcelLink(String name, IWorkbook sourceWorkbook)
      更新一个Excel链接。

    • updateExcelLinks

      void updateExcelLinks()
      更新所有Excel链接。

    • toSjsJson

      String toSjsJson()
      生成一个工作簿的JSON字符串。它将SpreadJS .sjs文件中的所有JSON文件集成到一个字符串中。
      返回:
      Json数据。

    • toSjsJson

      String toSjsJson(SjsSaveOptions options)
      从工作簿生成一个JSON字符串。它将SpreadJS .sjs文件中的所有JSON文件集成到一个字符串中。
      参数:
      options - 打开SpreadJS .sjs文件的选项。
      返回:
      Json数据。

    • toSjsJson

      void toSjsJson(OutputStream stream, SjsSaveOptions options)
      将SpreadJS .sjs文件中的所有JSON文件集成到一个字符串中，然后将该字符串放入流中。
      参数:
      stream - 指定的文件流。
      options - 打开SpreadJS .sjs文件的选项。

    • toSjsJson

      void toSjsJson(OutputStream stream)
      将SpreadJS .sjs文件中的所有JSON文件集成到一个字符串中，然后将该字符串放入流中。
      参数:
      stream - 指定的文件流。

    • convertBarcodeToPicture

      void convertBarcodeToPicture()
      将计算出的条形码转换为图片，并将它们放置在各自的位置。
      原始条形码公式将被清除。
      转换后的图片的 ImageType 是 ImageType.SVG。

    • convertBarcodeToPicture

      void convertBarcodeToPicture(ImageType imageType)
      将计算出的条形码转换为图片，并将它们放置在各自的位置。
      原始条形码公式将被清除。
      不支持 ImageType.EMF 和 ImageType.WMF 图像类型。
      参数:
      imageType - 指定转换后图像的 ImageType。
      抛出:
      UnsupportedOperationException - 如果转换到 ImageType.EMF 或 ImageType.WMF 图像类型。

    • fromSjsJson

      void fromSjsJson(String json)
      从包含.sjs文件格式的内容的JSON字符串生成一个工作簿。
      参数:
      json - JSON字符串。

    • fromSjsJson

      void fromSjsJson(String json, SjsOpenOptions openOptions)
      从包含 SpreadJS .sjs 文件格式的内容的 JSON 字符串生成一个工作簿。
      参数:
      json - JSON字符串。
      openOptions - 用于打开 SpreadJS .sjs 文件的打开选项。

    • fromSjsJson

      void fromSjsJson(InputStream stream, SjsOpenOptions openOptions)
      从包含.sjs文件格式的内容的JSON流生成一个工作簿。
      参数:
      stream - JSON流。
      openOptions - 用于打开SpreadJS .sjs文件的打开选项。

    • fromSjsJson

      void fromSjsJson(InputStream stream)
      从包含 .sjs 文件格式的内容的 JSON 流生成一个工作簿。
      参数:
      stream - JSON 流。

    • waitForCalculationToFinish

      void waitForCalculationToFinish()
      等待所有计算完成，包括异步计算。此方法会阻塞当前线程直到所有计算完成。用户可以调用此方法以确保在进行依赖于计算结果的任何其他操作之前，所有必要的计算都已经执行。