Class JsonFormatProvider

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.

Inheritance
System.Object
WorkbookFormatProviderBase
BinaryWorkbookFormatProviderBase
JsonFormatProvider
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 JsonFormatProvider : BinaryWorkbookFormatProviderBase, IBinaryWorkbookFormatProvider, IWorkbookFormatProvider

Constructors

JsonFormatProvider()

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

Declaration
public JsonFormatProvider()

Properties

CanExport

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

Declaration
public override bool CanExport { get; }
Property Value
System.Boolean

Overrides

CanImport

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

Declaration
public override bool CanImport { get; }
Property Value
System.Boolean

Overrides

ExportSettings

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

Declaration
public JsonExportSettings ExportSettings { get; set; }
Property Value
JsonExportSettings

FilesDescription

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

Declaration
public override string FilesDescription { get; }
Property Value
System.String

Overrides

Name

Gets the provider name.

Declaration
public override string Name { get; }
Property Value
System.String

Overrides

SupportedExtensions

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

Declaration
public override IEnumerable<string> SupportedExtensions { get; }
Property Value
System.Collections.Generic.IEnumerable<System.String>

Overrides

Methods

ExportOverride(Workbook, Stream)

Exports the specified workbook to the output output using System.Threading.CancellationToken.None.

Declaration
[Obsolete("This method is obsolete. Please use ExportOverride(Workbook workbook, Stream output, CancellationToken cancellationToken) instead.")]
protected override void ExportOverride(Workbook workbook, Stream output)
Parameters
Workbook workbook

The workbook to export.
System.IO.Stream output

The destination stream.
Overrides

ExportOverride(Workbook, Stream, CancellationToken)

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

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

The workbook to export.
System.IO.Stream output

The destination stream (must be writable).
System.Threading.CancellationToken cancellationToken

Token used to observe cancellation requests.
Overrides
Exceptions
System.ArgumentNullException

Thrown if workbook or output is null.

ImportOverride(Stream)

Import is not supported and always throws System.NotSupportedException.

Declaration
[Obsolete("Import not supported for JsonFormatProvider.")]
protected override Workbook ImportOverride(Stream input)
Parameters
System.IO.Stream input

The input stream.
Returns
Workbook

Never returns; always throws.
Overrides

ImportOverride(Stream, CancellationToken)

Import with cancellation is not supported and always throws System.NotSupportedException.

Declaration
protected override Workbook ImportOverride(Stream input, CancellationToken cancellationToken)
Parameters
System.IO.Stream input

The input stream.
System.Threading.CancellationToken cancellationToken

Cancellation token (ignored).
Returns
Workbook

Never returns; always throws.
Overrides