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

IWorkbookFormatProvider

Interface

Defines a common interface for workbook import and export format providers, enabling serialization and deserialization of workbooks to and from various file formats.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.FormatProviders

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

public interface IWorkbookFormatProvider

Derived Classes: BinaryWorkbookFormatProviderBaseJsonFormatProviderXlsmFormatProviderXlsxFormatProviderPdfFormatProviderCsvFormatProviderDelimitedValuesFormatProviderBaseTxtFormatProviderTextBasedWorkbookFormatProviderBaseWorkbookFormatProviderBaseXlsFormatProvider...

Methods

Export(Workbook, Stream, TimeSpan?)

Exports the specified workbook to the output stream with an optional timeout in the provider's format.

void Export(Workbook workbook, Stream output, TimeSpan? timeout)

Parameters:workbookWorkbook

The workbook.

outputStream

The output.

timeoutTimeSpan?

The timeout after which the operation will be cancelled.

Exceptions:

ArgumentOutOfRangeException

The exception that is thrown when timeout is less than -1 or greater than Int32.MaxValue. Note that this upper bound is more restrictive than TimeSpan.MaxValue.

Import(Stream, TimeSpan?)

Workbook

Imports a workbook from the specified stream with an optional timeout and returns the deserialized workbook instance.

Workbook Import(Stream input, TimeSpan? timeout)

Parameters:inputStream

The input.

timeoutTimeSpan?

The timeout after which the operation will be cancelled.

Returns:

Workbook

The imported workbook.

Exceptions:

ArgumentOutOfRangeException

The exception that is thrown when timeout is less than -1 or greater than Int32.MaxValue. Note that this upper bound is more restrictive than TimeSpan.MaxValue.

Properties

CanExport

bool

Gets a value indicating whether this provider supports exporting workbooks to streams.

bool CanExport { get; }

Property Value:

The value indicating whether can export.

CanImport

bool

Gets a value indicating whether this provider supports importing workbooks from streams.

bool CanImport { get; }

Property Value:

The value indicating whether can import.

FilesDescription

string

Gets the human-readable description of files supported by this provider, suitable for display in file dialogs.

string FilesDescription { get; }

Property Value:

The files description.

Name

string

Gets the unique identifier name of this format provider.

string Name { get; }

Property Value:

The name of the provider.

SupportedExtensions

IEnumerable<string>

Gets the collection of file extensions supported by this provider, each including the leading dot (e.g., ".xlsx").

IEnumerable<string> SupportedExtensions { get; }

Property Value:

The supported extensions.