Class JsonExportSettings

Provides configuration settings that control how a JsonFormatProvider exports a Workbook to JSON.

Inheritance
System.Object
JsonExportSettings
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Spreadsheet.FormatProviders.Json
Assembly: Telerik.Windows.Documents.Spreadsheet.FormatProviders.Json.dll

Syntax

public class JsonExportSettings
Remarks

Unless otherwise noted, all boolean properties default to a value that enables richer output (e.g. number formats, charts, summaries).

Constructors

JsonExportSettings()

Declaration
public JsonExportSettings()

Properties

ChartDataMode

Gets or sets how chart data should be represented (only references, only resolved values, or both).

Declaration
public ChartDataMode ChartDataMode { get; set; }
Property Value
ChartDataMode

ExportWhat

Gets or sets which portion of the workbook will be exported (entire workbook, only the active sheet, or only a selection of ranges).

Declaration
public ExportWhat ExportWhat { get; set; }
Property Value
ExportWhat

IncludeActiveSheet

Gets or sets a value indicating whether the name of the active worksheet is exported in the metadata section.

Declaration
public bool IncludeActiveSheet { get; set; }
Property Value
System.Boolean

IncludeBlankCells

Gets or sets a value indicating whether blank cells within the used range of a worksheet should be explicitly output. When false blank cells are skipped to reduce JSON size.

Declaration
public bool IncludeBlankCells { get; set; }
Property Value
System.Boolean

IncludeCharts

Gets or sets a value indicating whether charts in the exported worksheets are serialized.

Declaration
public bool IncludeCharts { get; set; }
Property Value
System.Boolean

IncludeChartStats

Gets or sets a value indicating whether per-series statistical aggregates (min, max, average, sum, standard deviation, count) are included for chart data.

Declaration
public bool IncludeChartStats { get; set; }
Property Value
System.Boolean

IncludeChartSummaries

Gets or sets a value indicating whether a human-readable summary string is generated for each chart.

Declaration
public bool IncludeChartSummaries { get; set; }
Property Value
System.Boolean

IncludeChartTrends

Gets or sets a value indicating whether a simple trend classification (increasing / decreasing / flat) is exported for eligible series.

Declaration
public bool IncludeChartTrends { get; set; }
Property Value
System.Boolean

IncludeDefinedNames

Gets or sets a value indicating whether defined names (named ranges / constants) are exported.

Declaration
public bool IncludeDefinedNames { get; set; }
Property Value
System.Boolean

IncludeHiddenSheets

Gets or sets a value indicating whether hidden worksheets are included when ExportWhat is EntireWorkbook.

Declaration
public bool IncludeHiddenSheets { get; set; }
Property Value
System.Boolean

IncludeNumberFormats

Gets or sets a value indicating whether cell number formats (format codes other than General) are emitted.

Declaration
public bool IncludeNumberFormats { get; set; }
Property Value
System.Boolean

IncludeWorkbookProtectionFlag

Gets or sets a value indicating whether the workbook protection flag (IsProtected) is included.

Declaration
public bool IncludeWorkbookProtectionFlag { get; set; }
Property Value
System.Boolean

PrettyPrint

Gets or sets a value indicating whether the JSON output should be indented (pretty printed) for readability.

Declaration
public bool PrettyPrint { get; set; }
Property Value
System.Boolean

SelectedRanges

Gets the collection of ranges to export when ExportWhat is Selection. If the collection is empty the active worksheet is exported instead.

Declaration
public List<CellRange> SelectedRanges { get; }
Property Value
System.Collections.Generic.List<CellRange>

ValueRenderMode

Gets or sets how cell values are rendered in the export (raw underlying value, formatted display value, or both).

Declaration
public ValueRenderMode ValueRenderMode { get; set; }
Property Value
ValueRenderMode