Class
JsonExportSettings

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

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Json

Assembly:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Json.dll

Syntax:

cs-api-definition
public class JsonExportSettings

Inheritance: objectJsonExportSettings

Constructors

JsonExportSettings()

Declaration

cs-api-definition
public JsonExportSettings()

Properties

ChartDataMode

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

Declaration

cs-api-definition
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

cs-api-definition
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

cs-api-definition
public bool IncludeActiveSheet { get; set; }

Property Value

bool

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

cs-api-definition
public bool IncludeBlankCells { get; set; }

Property Value

bool

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

cs-api-definition
public bool IncludeChartStats { get; set; }

Property Value

bool

IncludeChartSummaries

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

Declaration

cs-api-definition
public bool IncludeChartSummaries { get; set; }

Property Value

bool

IncludeChartTrends

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

Declaration

cs-api-definition
public bool IncludeChartTrends { get; set; }

Property Value

bool

IncludeCharts

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

Declaration

cs-api-definition
public bool IncludeCharts { get; set; }

Property Value

bool

IncludeDefinedNames

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

Declaration

cs-api-definition
public bool IncludeDefinedNames { get; set; }

Property Value

bool

IncludeHiddenSheets

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

Declaration

cs-api-definition
public bool IncludeHiddenSheets { get; set; }

Property Value

bool

IncludeNumberFormats

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

Declaration

cs-api-definition
public bool IncludeNumberFormats { get; set; }

Property Value

bool

IncludeWorkbookProtectionFlag

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

Declaration

cs-api-definition
public bool IncludeWorkbookProtectionFlag { get; set; }

Property Value

bool

PrettyPrint

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

Declaration

cs-api-definition
public bool PrettyPrint { get; set; }

Property Value

bool

SelectedRanges

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

Declaration

cs-api-definition
public List<CellRange> SelectedRanges { get; }

Property Value

List<CellRange>

ValueRenderMode

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

Declaration

cs-api-definition
public ValueRenderMode ValueRenderMode { get; set; }

Property Value

ValueRenderMode