Interface ITextBasedWorkbookFormatProvider

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

Inherited Members
Namespace: Telerik.Windows.Documents.Spreadsheet.FormatProviders
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public interface ITextBasedWorkbookFormatProvider : IWorkbookFormatProvider

Methods

Export(Workbook)

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

Declaration
[Obsolete("This method is obsolete. Please use Export(Workbook workbook, TimeSpan? timeout) instead.")]
string Export(Workbook workbook)
Parameters
Workbook workbook

The workbook.
Returns
System.String

The result string.

Export(Workbook, Nullable<TimeSpan>)

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

Declaration
string Export(Workbook workbook, TimeSpan? timeout)
Parameters
Workbook workbook

The workbook.
System.Nullable<System.TimeSpan> timeout

The timeout after which the operation will be cancelled.
Returns
System.String

The result string.
Exceptions
System.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
[Obsolete("This method is obsolete. Please use Import(string input, TimeSpan? timeout) instead.")]
Workbook Import(string input)
Parameters
System.String input

The input.
Returns
Workbook

The workbook.

Import(String, Nullable<TimeSpan>)

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

Declaration
Workbook Import(string input, TimeSpan? timeout)
Parameters
System.String input

The input.
System.Nullable<System.TimeSpan> timeout

The timeout after which the operation will be cancelled.
Returns
Workbook

The workbook.
Exceptions
System.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.