GrapeCity.Documents.Excel.SerializationOptions

SerializationOptions Class

Represents options used when serializing a workbook or worksheet to JSON.

Use this class to control which content is included in the generated JSON, such as styles, formulas, sheets, shared formulas, binding sources, and automatically merged cells. These options apply when calling ToJson(SerializationOptions) or ToJson(SerializationOptions).

Inheritance

object

SerializationOptions

Namespace: GrapeCity.Documents.Excel

Assembly: DS.Documents.Excel.dll

Syntax

public class SerializationOptions

Public Class SerializationOptions

Examples

SerializationOptions options = new SerializationOptions();
options.IgnoreStyle = true;
options.IgnoreFormula = true;
string jsonText = workbook.ToJson(options);

Constructors

Name	Description
SerializationOptions()	Initializes a new instance of the SerializationOptions class.

Properties

Name	Description
ExportSharedFormula	Gets or sets whether shared formulas are exported when serializing a workbook or worksheet to JSON. The default value is `true`. Set this option to `false` to omit shared formulas from the exported JSON, which can be useful for backward compatibility with earlier product versions or SpreadJS versions that do not support shared formulas.
IgnoreColumnRowInfoOutOfUsedRange	Gets or sets whether row and column information outside the used range is ignored when exporting to JSON. When this option is `true`, row styles, column styles, row heights, and column widths outside the used range are not exported. The default value is `true`.
IgnoreFormula	Gets or sets whether formulas are ignored when serializing a workbook or worksheet to JSON. If this property returns `true`, formula information is excluded from the serialized JSON output. The default value is `false`.
IgnoreRangeOutOfRowColumnCount	Gets or sets whether to ignore data outside the RowCount and ColumnCount when exporting to JSON. If this property is `true`, data outside the row and column count limits is ignored during JSON export. The default value is `false`.
IgnoreSheets	Gets or sets whether sheets are ignored when serializing a workbook or worksheet to JSON. If this property is `true`, the JSON output excludes worksheet data. The default value is `false`.
IgnoreStyle	Gets or sets whether styles are ignored when a workbook or worksheet is serialized to JSON. If this property is `true`, style information is excluded from the serialized JSON output. The default value is `false`.
IncludeAutoMergedCells	Gets or sets whether automatically merged cells are included during JSON serialization.
IncludeBindingSource	Gets or sets whether binding sources are included when a workbook or worksheet is serialized to JSON. If this property is `true`, bound data sources are included in the serialized JSON output. If this property is `false`, binding source information is not included. The default value is `true`.