SerializationOptions

Class SerializationOptions

java.lang.Object

com.grapecity.documents.excel.SerializationOptions

---

public class SerializationOptions extends Object

表示将工作簿或工作表序列化为 JSON 时使用的选项。

使用此类可以控制生成的 JSON 中包含哪些内容，例如样式、公式、工作表、共享公式、绑定源以及自动合并的单元格。调用 Workbook.toJson(SerializationOptions) 或IWorksheet.toJson(SerializationOptions) 时会应用这些选项。

 SerializationOptions options = new SerializationOptions();
 options.setIgnoreStyle(true);
 options.setIgnoreFormula(true);
 String jsonText = workbook.toJson(options);
 

• Constructor Summary

  Constructors

  Constructor

  Description

  SerializationOptions()

   

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  boolean

  getExportSharedFormula()

  获取在将工作簿或工作表序列化为 JSON 时是否导出共享公式。

  boolean

  getIgnoreColumnRowInfoOutOfUsedRange()

  获取导出为 JSON 时是否忽略已用区域之外的行和列信息。

  boolean

  getIgnoreFormula()

  获取在将工作簿或工作表序列化为 JSON 时是否忽略公式。

  boolean

  getIgnoreRangeOutOfRowColumnCount()

  获取导出为 JSON 时是否忽略 RowCount 和 ColumnCount 之外的数据。

  boolean

  getIgnoreSheets()

  获取在将工作簿或工作表序列化为 JSON 时是否忽略工作表。

  boolean

  getIgnoreStyle()

  获取在将工作簿或工作表序列化为 JSON 时是否忽略样式。

  boolean

  getIncludeAutoMergedCells()

  获取 JSON 序列化期间是否包含自动合并的单元格。

  final boolean

  getIncludeBindingSource()

  获取当工作簿或工作表序列化为 JSON 时是否包含绑定源。

  void

  setExportSharedFormula(boolean value)

  设置在将工作簿或工作表序列化为 JSON 时是否导出共享公式。

  void

  setIgnoreColumnRowInfoOutOfUsedRange(boolean value)

  设置导出为 JSON 时是否忽略已用区域之外的行和列信息。

  void

  setIgnoreFormula(boolean value)

  设置在将工作簿或工作表序列化为 JSON 时是否忽略公式。

  void

  setIgnoreRangeOutOfRowColumnCount(boolean value)

  设置导出为 JSON 时是否忽略 RowCount 和 ColumnCount 之外的数据。

  void

  setIgnoreSheets(boolean value)

  设置在将工作簿或工作表序列化为 JSON 时是否忽略工作表。

  void

  setIgnoreStyle(boolean value)

  设置在将工作簿或工作表序列化为 JSON 时是否忽略样式。

  void

  setIncludeAutoMergedCells(boolean value)

  设置 JSON 序列化期间是否包含自动合并的单元格。

  final void

  setIncludeBindingSource(boolean value)

  设置当工作簿或工作表序列化为 JSON 时是否包含绑定源。

  Methods inherited from class java.lang.Object

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

• Constructor Details

  • SerializationOptions

    public SerializationOptions()

• Method Details

  • getIgnoreStyle

    public boolean getIgnoreStyle()

    获取在将工作簿或工作表序列化为 JSON 时是否忽略样式。

    如果此属性为 true，则序列化的 JSON 输出中会排除样式信息。默认值为 false。

    
     SerializationOptions options = new SerializationOptions();
     options.setIgnoreStyle(true);
     boolean ignoreStyle = options.getIgnoreStyle();
     

    Returns:

    如果在 JSON 序列化期间忽略样式信息，则为 true；否则为 false。

  • setIgnoreStyle

    public void setIgnoreStyle(boolean value)

    设置在将工作簿或工作表序列化为 JSON 时是否忽略样式。

    如果此属性为 true，则序列化的 JSON 输出中会排除样式信息。默认值为 false。

    
     SerializationOptions options = new SerializationOptions();
     options.setIgnoreStyle(true);
     

    Parameters:

    value - 如果在 JSON 序列化期间忽略样式信息，则为 true；否则为 false。

  • getIgnoreFormula

    public boolean getIgnoreFormula()

    获取在将工作簿或工作表序列化为 JSON 时是否忽略公式。

    如果此属性返回 true，则序列化的 JSON 输出中会排除公式信息。默认值为 false。

    
     SerializationOptions options = new SerializationOptions();
     options.setIgnoreFormula(true);
     boolean ignoreFormula = options.getIgnoreFormula();
     

    Returns:

    如果在 JSON 序列化期间忽略公式，则为 true；否则为 false。

  • setIgnoreFormula

    public void setIgnoreFormula(boolean value)

    设置在将工作簿或工作表序列化为 JSON 时是否忽略公式。

    如果此属性为 true，则序列化的 JSON 输出中会排除公式信息。默认值为 false。

    
     SerializationOptions options = new SerializationOptions();
     options.setIgnoreFormula(true);
     

    Parameters:

    value - 如果在 JSON 序列化期间忽略公式，则为 true；否则为 false。

  • getIgnoreColumnRowInfoOutOfUsedRange

    public boolean getIgnoreColumnRowInfoOutOfUsedRange()

    获取导出为 JSON 时是否忽略已用区域之外的行和列信息。

    当此选项为 true 时，不会导出已用区域之外的行样式、列样式、行高和列宽。默认值为 true。

    
     SerializationOptions options = new SerializationOptions();
     options.setIgnoreColumnRowInfoOutOfUsedRange(false);
     boolean ignoreUnusedRowsAndColumns = options.getIgnoreColumnRowInfoOutOfUsedRange();
     

    Returns:

    如果在 JSON 导出期间忽略已用区域之外的行样式、列样式、行高和列宽，则为 true；否则为 false。

  • setIgnoreColumnRowInfoOutOfUsedRange

    public void setIgnoreColumnRowInfoOutOfUsedRange(boolean value)

    设置导出为 JSON 时是否忽略已用区域之外的行和列信息。

    当此选项为 true 时，不会导出已用区域之外的行样式、列样式、行高和列宽。默认值为 true。

    
     SerializationOptions options = new SerializationOptions();
     options.setIgnoreColumnRowInfoOutOfUsedRange(false);
     

    Parameters:

    value - 如果在 JSON 导出期间忽略已用区域之外的行样式、列样式、行高和列宽，则为 true；否则为 false。

  • getIgnoreSheets

    public boolean getIgnoreSheets()

    获取在将工作簿或工作表序列化为 JSON 时是否忽略工作表。

    如果此属性为 true，则 JSON 输出会排除工作表数据。默认值为 false。

    
     SerializationOptions options = new SerializationOptions();
     options.setIgnoreSheets(true);
     boolean ignoreSheets = options.getIgnoreSheets();
     

    Returns:

    如果在 JSON 序列化期间忽略工作表，则为 true；否则为 false。

  • setIgnoreSheets

    public void setIgnoreSheets(boolean value)

    设置在将工作簿或工作表序列化为 JSON 时是否忽略工作表。

    如果此属性为 true，则 JSON 输出会排除工作表数据。默认值为 false。

    
     SerializationOptions options = new SerializationOptions();
     options.setIgnoreSheets(true);
     

    Parameters:

    value - 如果在 JSON 序列化期间忽略工作表，则为 true；否则为 false。

  • getIgnoreRangeOutOfRowColumnCount

    public boolean getIgnoreRangeOutOfRowColumnCount()

    获取导出为 JSON 时是否忽略 RowCount 和 ColumnCount 之外的数据。

    如果此属性为 true，则在 JSON 导出期间会忽略行数和列数限制之外的数据。默认值为 false。

    
     SerializationOptions options = new SerializationOptions();
     options.setIgnoreRangeOutOfRowColumnCount(true);
     boolean ignoreRangeOutOfBounds = options.getIgnoreRangeOutOfRowColumnCount();
     

    Returns:

    如果在 JSON 导出期间忽略 RowCount 和 ColumnCount 之外的数据，则为 true；否则为 false。

  • setIgnoreRangeOutOfRowColumnCount

    public void setIgnoreRangeOutOfRowColumnCount(boolean value)

    设置导出为 JSON 时是否忽略 RowCount 和 ColumnCount 之外的数据。

    如果此属性为 true，则在 JSON 导出期间会忽略行数和列数限制之外的数据。默认值为 false。

    
     SerializationOptions options = new SerializationOptions();
     options.setIgnoreRangeOutOfRowColumnCount(true);
     

    Parameters:

    value - 如果在 JSON 导出期间忽略 RowCount 和 ColumnCount 之外的数据，则为 true；否则为 false。

  • getExportSharedFormula

    public boolean getExportSharedFormula()

    获取在将工作簿或工作表序列化为 JSON 时是否导出共享公式。

    默认值为 true。将此选项设置为 false 可从导出的 JSON 中省略共享公式，这对于与不支持共享公式的早期 DsExcel 版本或 SpreadJS 版本保持向后兼容很有用。

    
     SerializationOptions options = new SerializationOptions();
     options.setExportSharedFormula(false);
     boolean exportSharedFormula = options.getExportSharedFormula();
     

    Returns:

    如果将共享公式导出到 JSON，则为 true；否则为 false。

  • setExportSharedFormula

    public void setExportSharedFormula(boolean value)

    设置在将工作簿或工作表序列化为 JSON 时是否导出共享公式。

    默认值为 true。将此选项设置为 false 可从导出的 JSON 中省略共享公式，这对于与不支持共享公式的早期 DsExcel 版本或 SpreadJS 版本保持向后兼容很有用。

    
     SerializationOptions options = new SerializationOptions();
     options.setExportSharedFormula(false);
     

    Parameters:

    value - 如果将共享公式导出到 JSON，则为 true；否则为 false。

  • getIncludeBindingSource

    public final boolean getIncludeBindingSource()

    获取当工作簿或工作表序列化为 JSON 时是否包含绑定源。

    如果此属性为 true，则绑定的数据源会包含在序列化后的 JSON 输出中。如果此属性为 false，则不包含绑定源信息。默认值为 true。

    
     SerializationOptions options = new SerializationOptions();
     options.setIncludeBindingSource(false);
     boolean includeBindingSource = options.getIncludeBindingSource();
     

    Returns:

    如果在 JSON 序列化期间包含绑定源，则为 true；否则为 false。

  • setIncludeBindingSource

    public final void setIncludeBindingSource(boolean value)

    设置当工作簿或工作表序列化为 JSON 时是否包含绑定源。

    如果此属性为 true，则绑定的数据源会包含在序列化后的 JSON 输出中。如果此属性为 false，则不包含绑定源信息。默认值为 true。

    
     SerializationOptions options = new SerializationOptions();
     options.setIncludeBindingSource(false);
     

    Parameters:

    value - 如果在 JSON 序列化期间包含绑定源，则为 true；否则为 false。

  • getIncludeAutoMergedCells

    public boolean getIncludeAutoMergedCells()

    获取 JSON 序列化期间是否包含自动合并的单元格。

    当此属性为 true 时，添加到工作表的自动合并信息可以在将工作簿或工作表序列化为 JSON 时生效。默认值为 false。

    
     SerializationOptions options = new SerializationOptions();
     options.setIncludeAutoMergedCells(true);
     boolean includeAutoMergedCells = options.getIncludeAutoMergedCells();
     

    Returns:

    如果 JSON 序列化期间包含自动合并的单元格，则为 true；否则为 false。

  • setIncludeAutoMergedCells

    public void setIncludeAutoMergedCells(boolean value)

    设置 JSON 序列化期间是否包含自动合并的单元格。

    
     SerializationOptions options = new SerializationOptions();
     options.setIncludeAutoMergedCells(true);
     

    Parameters:

    value - 如果 JSON 序列化期间包含自动合并的单元格，则为 true；否则为 false。