GrapeCity.Documents.Excel.IWorkbook.FromJson

FromJson Method

FromJson(string, DeserializationOptions)

Loads workbook content from a SpreadJS JSON (SSJSON) string into this workbook.

Use this method to control deserialization behavior with a DeserializationOptions instance. The returned list contains any JsonError objects found during deserialization.

Declaration

IList<JsonError> FromJson(string json, DeserializationOptions deserializationOptions = null)

Function FromJson(json As String, Optional deserializationOptions As DeserializationOptions = Nothing) As IList(Of JsonError)

Parameters

Type	Name	Description
string	json	The SpreadJS JSON (SSJSON) string to load into this workbook. Must not be null.
DeserializationOptions	deserializationOptions	The DeserializationOptions object that controls how the JSON content is deserialized. If null, default deserialization options are used.

Returns

Type	Description
IList<JsonError>	A list of JsonError objects found during deserialization.

Examples

worksheet.Range["A1"].Value = "Name";
worksheet.Range["B1"].Value = "Test";
string json = workbook.ToJson();
DeserializationOptions options = new DeserializationOptions();
IWorkbook importedWorkbook = new Workbook();
IList<JsonError> errors = importedWorkbook.FromJson(json, options);

FromJson(Stream, DeserializationOptions)

Loads workbook content from a SpreadJS JSON (SSJSON) stream into this workbook.

Use this method to control deserialization behavior with a DeserializationOptions instance. The returned list contains any JsonError objects found during deserialization.

Declaration

IList<JsonError> FromJson(Stream stream, DeserializationOptions deserializationOptions = null)

Function FromJson(stream As Stream, Optional deserializationOptions As DeserializationOptions = Nothing) As IList(Of JsonError)

Parameters

Type	Name	Description
Stream	stream	The input stream that provides the SpreadJS JSON (SSJSON) content to load. Must not be null.
DeserializationOptions	deserializationOptions	The DeserializationOptions object that controls how the JSON content is deserialized. If null, default deserialization options are used.

Returns

Type	Description
IList<JsonError>	A list of JsonError objects found during deserialization.

Examples

worksheet.Range["A1"].Value = "Name";
string json = workbook.ToJson();
DeserializationOptions options = new DeserializationOptions();
options.DoNotRecalculateAfterLoad = true;
IWorkbook importedWorkbook = new Workbook();
IList<JsonError> errors = importedWorkbook.FromJson(
    new MemoryStream(System.Text.Encoding.UTF8.GetBytes(json)),
    options
);