Interface
ITextBasedWorkbookFormatProvider

Interface for format providers that import and export workbooks using text-based formats such as CSV and TXT.

Definition

Methods

Export(Workbook)

Exports the specified workbook to a text string without timeout support.

Declaration

cs-api-definition
[Obsolete("This method is obsolete. Please use Export(Workbook workbook, TimeSpan? timeout) instead.")]
string Export(Workbook workbook)

Parameters

workbook

Workbook

The workbook.

Returns

string

The result string.

Export(Workbook, TimeSpan?)

Exports the specified workbook to a text string with optional timeout to prevent long-running operations.

Declaration

cs-api-definition
string Export(Workbook workbook, TimeSpan? timeout)

Parameters

workbook

Workbook

The workbook.

timeout

TimeSpan?

The timeout after which the operation will be cancelled.

Returns

string

The result string.

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(string)

Imports a workbook from the specified text string without timeout support.

Declaration

cs-api-definition
[Obsolete("This method is obsolete. Please use Import(string input, TimeSpan? timeout) instead.")]
Workbook Import(string input)

Parameters

input

string

The input.

Returns

Workbook

The workbook.

Import(string, TimeSpan?)

Imports a workbook from the specified text string with optional timeout to prevent long-running operations.

Declaration

cs-api-definition
Workbook Import(string input, TimeSpan? timeout)

Parameters

input

string

The input.

timeout

TimeSpan?

The timeout after which the operation will be cancelled.

Returns

Workbook

The 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.