New to Telerik Document Processing? Start a free 30-day trial

JsonFormatProvider

Class

A workbook format provider that exports spreadsheet content to a structured JSON representation. This provider is export-only; importing JSON back into a workbook is not supported.

Definition

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

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

Syntax:

public class JsonFormatProvider : BinaryWorkbookFormatProviderBase, IBinaryWorkbookFormatProvider, IWorkbookFormatProvider

Inheritance: objectWorkbookFormatProviderBaseBinaryWorkbookFormatProviderBaseJsonFormatProvider

Implements: IBinaryWorkbookFormatProviderIWorkbookFormatProvider

Inherited Members BinaryWorkbookFormatProviderBase.Import(byte[], TimeSpan?)BinaryWorkbookFormatProviderBase.Export(Workbook, TimeSpan?)WorkbookFormatProviderBase.Import(Stream, TimeSpan?)WorkbookFormatProviderBase.Export(Workbook, Stream, TimeSpan?)

Constructors

JsonFormatProvider()

Initializes a new instance of the JsonFormatProvider class with default JsonExportSettings.

public JsonFormatProvider()

Methods

ExportOverride(Workbook, Stream, CancellationToken)

Performs the export operation writing a JSON representation of workbook into output.

protected override void ExportOverride(Workbook workbook, Stream output, CancellationToken cancellationToken)

Parameters:workbookWorkbook

The workbook to export.

outputStream

The destination stream (must be writable).

cancellationTokenCancellationToken

Token used to observe cancellation requests.

Exceptions:

ArgumentNullException

Thrown if workbook or output is null.

Overrides: WorkbookFormatProviderBase.ExportOverride(Workbook, Stream, CancellationToken)

ImportOverride(Stream, CancellationToken)

Workbook

Import with cancellation is not supported and always throws NotSupportedException.

protected override Workbook ImportOverride(Stream input, CancellationToken cancellationToken)

Parameters:inputStream

The input stream.

cancellationTokenCancellationToken

Cancellation token (ignored).

Returns:

Workbook

Never returns; always throws.

Overrides: WorkbookFormatProviderBase.ImportOverride(Stream, CancellationToken)

Properties

CanExport

bool

Gets a value indicating whether export is supported (always true).

public override bool CanExport { get; }

Overrides: WorkbookFormatProviderBase.CanExport

CanImport

bool

Gets a value indicating whether import is supported (always false for this provider).

public override bool CanImport { get; }

Overrides: WorkbookFormatProviderBase.CanImport

ExportSettings

JsonExportSettings

Gets or sets the export settings controlling JSON output. If null at export time, defaults are applied.

public JsonExportSettings ExportSettings { get; set; }

FilesDescription

string

Gets a human-readable description of the file type handled by this provider.

public override string FilesDescription { get; }

Overrides: WorkbookFormatProviderBase.FilesDescription

Name

string

Gets the provider name.

public override string Name { get; }

Overrides: WorkbookFormatProviderBase.Name

SupportedExtensions

IEnumerable<string>

Gets the set of supported file extensions (currently only ".json").

public override IEnumerable<string> SupportedExtensions { get; }

Overrides: WorkbookFormatProviderBase.SupportedExtensions