Class TextBasedWorkbookFormatProviderBase

Base class for text-based workbook format providers that offer string-based import and export methods in addition to stream-based operations.

Inheritance
System.Object
WorkbookFormatProviderBase
TextBasedWorkbookFormatProviderBase
DelimitedValuesFormatProviderBase
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
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public abstract class TextBasedWorkbookFormatProviderBase : WorkbookFormatProviderBase, ITextBasedWorkbookFormatProvider, IWorkbookFormatProvider

Constructors

TextBasedWorkbookFormatProviderBase()

Initializes a new instance of the TextBasedWorkbookFormatProviderBase class.

Declaration
protected TextBasedWorkbookFormatProviderBase()

Methods

Export(Workbook)

Exports the specified workbook to a text string in the provider's format and returns the serialized result.

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

The workbook.
Returns
System.String

The result string.
Implements

Export(Workbook, Nullable<TimeSpan>)

Exports the specified workbook to a text string with an optional timeout in the provider's format and returns the serialized result.

Declaration
public 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.
Implements
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 and returns the deserialized workbook instance.

Declaration
[Obsolete("This method is obsolete. Please use Import(string input, TimeSpan? timeout) instead.")]
public Workbook Import(string input)
Parameters
System.String input

The input.
Returns
Workbook

The result workbook.
Implements

Import(String, Nullable<TimeSpan>)

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

Declaration
public 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 result workbook.
Implements
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.