DeserializationOptions

Class DeserializationOptions

java.lang.Object

com.grapecity.documents.excel.DeserializationOptions

---

public class DeserializationOptions extends Object

表示控制如何从 JSON 反序列化工作簿或工作表内容的选项。

使用此类可以为 Workbook.fromJson(String,DeserializationOptions) 和 Workbook.open(String,DeserializationOptions) 等 API 配置 JSON 加载行为。可以使用这些选项忽略样式、忽略公式，或防止加载 JSON 数据后重新计算。

 DeserializationOptions options = new DeserializationOptions();
 options.setIgnoreStyle(true);
 options.setIgnoreFormula(true);
 workbook.fromJson(jsonText, options);
 

• Constructor Summary

  Constructors

  Constructor

  Description

  DeserializationOptions()

   

• Method Summary

  All MethodsInstance MethodsConcrete Methods

  Modifier and Type

  Method

  Description

  boolean

  getDoNotRecalculateAfterLoad()

  获取加载 JSON 数据后是否跳过将公式标记为 dirty。

  boolean

  getIgnoreFormula()

  获取从 JSON 反序列化工作簿或工作表时是否忽略公式。

  boolean

  getIgnoreStyle()

  获取从 JSON 反序列化工作簿或工作表时是否忽略样式。

  InvalidFormulaHandling

  getInvalidFormulaHandling()

  获取反序列化 JSON 数据时对无效公式的处理方式。默认值为 null。

  void

  setDoNotRecalculateAfterLoad(boolean value)

  设置加载 JSON 数据后是否跳过将公式标记为 dirty。

  void

  setIgnoreFormula(boolean value)

  设置从 JSON 反序列化工作簿或工作表时是否忽略公式。

  void

  setIgnoreStyle(boolean value)

  设置从 JSON 反序列化工作簿或工作表时是否忽略样式。

  void

  setInvalidFormulaHandling(InvalidFormulaHandling value)

  设置反序列化 JSON 数据时对无效公式的处理方式。默认值为 null。

  Methods inherited from class java.lang.Object

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

• Constructor Details

  • DeserializationOptions

    public DeserializationOptions()

• Method Details

  • getIgnoreStyle

    public boolean getIgnoreStyle()

    获取从 JSON 反序列化工作簿或工作表时是否忽略样式。

    如果此属性为 true，则反序列化期间会忽略 JSON 数据中的样式信息。默认值为 false。

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

    Returns:

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

  • setIgnoreStyle

    public void setIgnoreStyle(boolean value)

    设置从 JSON 反序列化工作簿或工作表时是否忽略样式。

    如果此属性为 true，则反序列化期间会忽略 JSON 数据中的样式信息。默认值为 false。

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

    Parameters:

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

  • getIgnoreFormula

    public boolean getIgnoreFormula()

    获取从 JSON 反序列化工作簿或工作表时是否忽略公式。

    如果此属性为 true，则反序列化期间会忽略 JSON 数据中的公式信息。默认值为 false。

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

    Returns:

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

  • setIgnoreFormula

    public void setIgnoreFormula(boolean value)

    设置从 JSON 反序列化工作簿或工作表时是否忽略公式。

    如果此属性为 true，则反序列化期间会忽略 JSON 数据中的公式信息。默认值为 false。

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

    Parameters:

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

  • getDoNotRecalculateAfterLoad

    public boolean getDoNotRecalculateAfterLoad()

    获取加载 JSON 数据后是否跳过将公式标记为 dirty。

    此选项由 Workbook.fromJson(String,DeserializationOptions) 和 Workbook.open(String,DeserializationOptions) 等 JSON 反序列化 API 使用。默认值为 false。

    当此属性为 true 时，公式在加载后不会被标记为 dirty，因此触发计算时会返回从 JSON 加载的公式结果。当此属性为 false 时，公式在加载后会被标记为 dirty，因此触发计算时会重新计算公式结果。可以通过获取公式值或调用 Workbook.calculate() 等操作触发计算。

    
     DeserializationOptions openOptions = new DeserializationOptions();
     openOptions.setDoNotRecalculateAfterLoad(true);
     boolean doNotRecalculate = openOptions.getDoNotRecalculateAfterLoad();
     workbook.open("source.json", openOptions);
     

    Returns:

    如果加载 JSON 数据后跳过将公式标记为 dirty，则为 true；否则为 false。

  • setDoNotRecalculateAfterLoad

    public void setDoNotRecalculateAfterLoad(boolean value)

    设置加载 JSON 数据后是否跳过将公式标记为 dirty。

    此选项由 Workbook.fromJson(String,DeserializationOptions) 和 Workbook.open(String,DeserializationOptions) 等 JSON 反序列化 API 使用。默认值为 false。

    当此属性为 true 时，公式在加载后不会被标记为 dirty，因此触发计算时会返回从 JSON 加载的公式结果。当此属性为 false 时，公式在加载后会被标记为 dirty，因此触发计算时会重新计算公式结果。可以通过获取公式值或调用 Workbook.calculate() 等操作触发计算。

    
     DeserializationOptions openOptions = new DeserializationOptions();
     openOptions.setDoNotRecalculateAfterLoad(true);
     workbook.open("source.json", openOptions);
     

    Parameters:

    value - 如果加载 JSON 数据后跳过将公式标记为 dirty，则为 true；否则为 false。

  • getInvalidFormulaHandling

    public InvalidFormulaHandling getInvalidFormulaHandling()

    获取反序列化 JSON 数据时对无效公式的处理方式。默认值为 null。

    
     DeserializationOptions options = new DeserializationOptions();
     options.setInvalidFormulaHandling(InvalidFormulaHandling.Preserve);
     InvalidFormulaHandling invalidFormulaHandling = options.getInvalidFormulaHandling();
     

    Returns:

    反序列化 JSON 数据时对无效公式的处理方式。

  • setInvalidFormulaHandling

    public void setInvalidFormulaHandling(InvalidFormulaHandling value)

    设置反序列化 JSON 数据时对无效公式的处理方式。默认值为 null。

    
     DeserializationOptions options = new DeserializationOptions();
     options.setInvalidFormulaHandling(InvalidFormulaHandling.Preserve);
     

    Parameters:

    value - 反序列化 JSON 数据时对无效公式的处理方式。