ClassTextBasedWorkbookFormatProviderBase
Base class for text-based workbook format providers that offer string-based import and export methods in addition to stream-based operations.
Definition
Namespace:Telerik.Windows.Documents.Spreadsheet.FormatProviders
Assembly:Telerik.Windows.Documents.Spreadsheet.dll
Syntax:
public abstract class TextBasedWorkbookFormatProviderBase : WorkbookFormatProviderBase, ITextBasedWorkbookFormatProvider, IWorkbookFormatProviderInheritance: objectWorkbookFormatProviderBaseTextBasedWorkbookFormatProviderBase
Derived Classes:
Implements:
Inherited Members
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.
Export(Workbook, 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
The workbook.
timeout
The timeout after which the operation will be cancelled.
Returns
The result string.
Exceptions
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.
Implements
Import(string)
Imports a workbook from the specified text string and returns the deserialized workbook instance.
Import(string, 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
input
The input.
timeout
The timeout after which the operation will be cancelled.
Returns
The result workbook.
Exceptions
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.
Implements