Class XlsFormatProvider

Imports and exports workbooks in XLS (Excel 97-2003 BIFF8) format by converting through XLSX for compatibility.

Inheritance
System.Object
WorkbookFormatProviderBase
BinaryWorkbookFormatProviderBase
XlsFormatProvider
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.Xls
Assembly: Telerik.Windows.Documents.Spreadsheet.FormatProviders.Xls.dll

Syntax

public class XlsFormatProvider : BinaryWorkbookFormatProviderBase, IBinaryWorkbookFormatProvider, IWorkbookFormatProvider

Constructors

XlsFormatProvider()

Initializes a new instance of the XlsFormatProvider class.

Declaration
public XlsFormatProvider()

Properties

CanExport

Indicates that this provider supports exporting workbooks to XLS format.

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

The value indicating whether can export.
Overrides

CanImport

Indicates that this provider supports importing XLS files into workbooks.

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

The value indicating whether can import.
Overrides

FilesDescription

Describes the file type as "Excel 97-2003 Workbook" for display in UI contexts.

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

The files description.
Overrides

Name

Identifies this format provider as "XlsFormatProvider" for registration and lookup.

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

The name of the provider.
Overrides

SupportedExtensions

Specifies that this provider handles files with .xls extension.

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

The supported extensions.
Overrides

Methods

ExportOverride(Workbook, Stream)

Exports the specified workbook.

Declaration
[Obsolete("This method is obsolete. Please use ExportOverride(Workbook workbook, Stream output, CancellationToken cancellationToken) instead.")]
protected override void ExportOverride(Workbook workbook, Stream output)
Parameters
Workbook workbook

The workbook.
System.IO.Stream output

The output.
Overrides

ExportOverride(Workbook, Stream, CancellationToken)

Writes the workbook to the stream in XLS format by exporting to XLSX first, then converting to BIFF8 for compatibility.

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

The workbook.
System.IO.Stream output

The output.
System.Threading.CancellationToken cancellationToken

The cancellation token used to cancel the operation.
Overrides

ImportOverride(Stream)

Imports the specified input.

Declaration
[Obsolete("This method is obsolete. Please use ImportOverride(Stream input, CancellationToken cancellationToken) instead.")]
protected override Workbook ImportOverride(Stream input)
Parameters
System.IO.Stream input

The input.
Returns
Workbook

The imported workbook.
Overrides

ImportOverride(Stream, CancellationToken)

Reads XLS data from the stream by converting BIFF8 format to XLSX internally, then importing as XLSX for compatibility.

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

The input.
System.Threading.CancellationToken cancellationToken

The cancellation token used to cancel the operation.
Returns
Workbook

The imported workbook.
Overrides