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

ITextBasedWorkbookFormatProvider

Interface

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

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.FormatProviders

Assembly:Telerik.Windows.Documents.Spreadsheet.dll

Syntax:

public interface ITextBasedWorkbookFormatProvider : IWorkbookFormatProvider

Derived Classes: CsvFormatProviderDelimitedValuesFormatProviderBaseTxtFormatProviderTextBasedWorkbookFormatProviderBase

Inherited Members IWorkbookFormatProvider.Import(Stream, TimeSpan?)IWorkbookFormatProvider.Export(Workbook, Stream, TimeSpan?)IWorkbookFormatProvider.NameIWorkbookFormatProvider.FilesDescriptionIWorkbookFormatProvider.SupportedExtensionsIWorkbookFormatProvider.CanImportIWorkbookFormatProvider.CanExport...

Methods

Export(Workbook, TimeSpan?)

string

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

string Export(Workbook workbook, TimeSpan? timeout)

Parameters:workbookWorkbook

The workbook.

timeoutTimeSpan?

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, TimeSpan?)

Workbook

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

Workbook Import(string input, TimeSpan? timeout)

Parameters:inputstring

The input.