OpenOptionsBase

Class OpenOptionsBase

java.lang.Object

com.grapecity.documents.excel.OpenOptionsBase

Direct Known Subclasses:

CsvOpenOptions, SjsOpenOptions, XlsxOpenOptions

---

public abstract class OpenOptionsBase extends Object

工作簿打开选项的基类。

此抽象类定义传递给工作簿打开 API 的选项对象的通用约定。具体子类表示打开不同工作簿源的格式特定设置，例如 CSV、XLSX、XLSM、XLTX 或 SpreadJS .sjs 内容。

每个子类通过 setFileFormat(OpenFileFormat) 分配其关联的 OpenFileFormat，并可以公开其目标格式的其他设置。使用 getFileFormat() 可检查与具体选项实例关联的格式。

• Constructor Summary

  Constructors

  Constructor

  Description

  OpenOptionsBase()

   

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  final OpenFileFormat

  getFileFormat()

  获取这些打开选项的文件格式设置。

  protected final void

  setFileFormat(OpenFileFormat value)

  设置这些打开选项使用的文件格式。

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Constructor Details

  • OpenOptionsBase

    public OpenOptionsBase()

• Method Details

  • getFileFormat

    public final OpenFileFormat getFileFormat()

    获取这些打开选项的文件格式设置。

    此值标识与当前选项实例关联的工作簿格式，例如 OpenFileFormat.Csv 对应 CsvOpenOptions，或 OpenFileFormat.Sjs 对应 SjsOpenOptions。

    
     CsvOpenOptions options = new CsvOpenOptions();
     OpenFileFormat fileFormat = options.getFileFormat();
     workbook.open("path/to/data.csv", options);
     

    Returns:

    与这些打开选项关联的文件格式。

  • setFileFormat

    protected final void setFileFormat(OpenFileFormat value)

    设置这些打开选项使用的文件格式。

    此方法会更新 OpenFileFormat 值，该值由 getFileFormat() 返回。它供需要标识要打开的工作簿格式的派生选项类使用，例如 CSV、XLSX、XLSM、XLTX 或 SJS。

    
     class CustomOpenOptions extends OpenOptionsBase {
         CustomOpenOptions() {
             setFileFormat(OpenFileFormat.Sjs);
         }
     }
     CustomOpenOptions options = new CustomOpenOptions();
     

    Parameters:

    value - 要用于这些打开选项的文件格式。不能为 null。