ClassXlsFormatProvider
Imports and exports workbooks in XLS (Excel 97-2003 BIFF8) format by converting through XLSX for compatibility.
Definition
Namespace:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Xls
Assembly:Telerik.Windows.Documents.Spreadsheet.FormatProviders.Xls.dll
Syntax:
public class XlsFormatProvider : BinaryWorkbookFormatProviderBase, IBinaryWorkbookFormatProvider, IWorkbookFormatProvider
Inheritance: objectWorkbookFormatProviderBaseBinaryWorkbookFormatProviderBaseXlsFormatProvider
Implements:
Inherited Members
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
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
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
The files description.
Overrides
Name
Identifies this format provider as "XlsFormatProvider" for registration and lookup.
Declaration
public override string Name { get; }
Property Value
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
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
The workbook.
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
The workbook.
output
The output.
cancellationToken
The cancellation token used to cancel the operation.
Overrides
ImportOverride(Stream)
Imports the specified input.
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
input
The input.
cancellationToken
The cancellation token used to cancel the operation.
Returns
The imported workbook.
Overrides