Class WorkbookFormatProviderBase

Provides the base class from which the classes that represent workbook format providers are derived.

Inheritance
System.Object
WorkbookFormatProviderBase
BinaryWorkbookFormatProviderBase
TextBasedWorkbookFormatProviderBase
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 WorkbookFormatProviderBase : IWorkbookFormatProvider

Constructors

WorkbookFormatProviderBase()

Declaration
protected WorkbookFormatProviderBase()

Properties

CanExport

Gets a value indicating whether can export.

Declaration
public abstract bool CanExport { get; }
Property Value
System.Boolean

The value indicating whether can export.
Implements

CanImport

Gets a value indicating whether can import.

Declaration
public abstract bool CanImport { get; }
Property Value
System.Boolean

The value indicating whether can import.
Implements

FilesDescription

Gets the files description.

Declaration
public virtual string FilesDescription { get; }
Property Value
System.String

The files description.
Implements

Name

Gets the name.

Declaration
public abstract string Name { get; }
Property Value
System.String

The name of the provider.
Implements

SupportedExtensions

Gets the supported extensions.

Declaration
public abstract IEnumerable<string> SupportedExtensions { get; }
Property Value
System.Collections.Generic.IEnumerable<System.String>

The supported extensions.
Implements

Methods

Export(Workbook, Stream)

Exports the specified workbook.

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

The workbook.
System.IO.Stream output

The output.
Implements

Export(Workbook, Stream, Nullable<TimeSpan>)

Exports the specified workbook.

Declaration
public void Export(Workbook workbook, Stream output, TimeSpan? timeout)
Parameters
Workbook workbook

The workbook.
System.IO.Stream output

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

The timeout after which the operation will be cancelled.
Implements

ExportOverride(Workbook, Stream)

Exports the specified workbook.

Declaration
[Obsolete("Use ExportOverride(Workbook workbook, Stream output, CancellationToken cancellationToken) instead.")]
protected virtual void ExportOverride(Workbook workbook, Stream output)
Parameters
Workbook workbook

The workbook.
System.IO.Stream output

The output.

ExportOverride(Workbook, Stream, CancellationToken)

Exports the specified workbook.

Declaration
protected virtual void ExportOverride(Workbook workbook, Stream output, CancellationToken cancellationToken)
Parameters
Workbook workbook

The workbook.
System.IO.Stream output

The output.
System.Threading.CancellationToken cancellationToken

The token used to cancel the operation.

Import(Stream)

Imports the specified input.

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

The input.
Returns
Workbook

The imported workbook.
Implements

Import(Stream, Nullable<TimeSpan>)

Imports the specified input.

Declaration
public Workbook Import(Stream input, TimeSpan? timeout)
Parameters
System.IO.Stream input

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

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

The imported workbook.
Implements

ImportOverride(Stream)

Imports the specified input.

Declaration
[Obsolete("Use ImportOverride(Stream input, CancellationToken cancellationToken) instead.")]
protected virtual Workbook ImportOverride(Stream input)
Parameters
System.IO.Stream input

The input.
Returns
Workbook

The imported workbook.

ImportOverride(Stream, CancellationToken)

Imports the specified input.

Declaration
protected virtual Workbook ImportOverride(Stream input, CancellationToken cancellationToken)
Parameters
System.IO.Stream input

The input.
System.Threading.CancellationToken cancellationToken

The token used to cancel the operation.
Returns
Workbook

The imported workbook.

Extension Methods