Class
XlsxFormatProvider

Imports and exports workbooks in XLSX (Office Open XML) format, supporting full-fidelity roundtrip of spreadsheet data.

Definition

Namespace:Telerik.Windows.Documents.Spreadsheet.FormatProviders.OpenXml.Xlsx

Assembly:Telerik.Windows.Documents.Spreadsheet.FormatProviders.OpenXml.dll

Syntax:

cs-api-definition
public class XlsxFormatProvider : BinaryWorkbookFormatProviderBase, IBinaryWorkbookFormatProvider, IWorkbookFormatProvider

Inheritance: objectWorkbookFormatProviderBaseBinaryWorkbookFormatProviderBaseXlsxFormatProvider

Implements: IBinaryWorkbookFormatProviderIWorkbookFormatProvider

Inherited Members BinaryWorkbookFormatProviderBase.Import(byte[])BinaryWorkbookFormatProviderBase.Import(byte[], TimeSpan?)BinaryWorkbookFormatProviderBase.Export(Workbook)BinaryWorkbookFormatProviderBase.Export(Workbook, TimeSpan?)WorkbookFormatProviderBase.Import(Stream)WorkbookFormatProviderBase.Import(Stream, TimeSpan?)WorkbookFormatProviderBase.Export(Workbook, Stream)WorkbookFormatProviderBase.Export(Workbook, Stream, TimeSpan?)

Constructors

XlsxFormatProvider()

Initializes a new instance of the XlsxFormatProvider class.

Declaration

cs-api-definition
public XlsxFormatProvider()

Properties

CanExport

Indicates that this provider supports exporting workbooks to XLSX format.

Declaration

cs-api-definition
public override bool CanExport { get; }

Property Value

bool

The value indicating whether can export.

Overrides WorkbookFormatProviderBase.CanExport

CanImport

Indicates that this provider supports importing XLSX files into workbooks.

Declaration

cs-api-definition
public override bool CanImport { get; }

Property Value

bool

The value indicating whether can import.

Overrides WorkbookFormatProviderBase.CanImport

FilesDescription

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

Declaration

cs-api-definition
public override string FilesDescription { get; }

Property Value

string

The files description.

Overrides WorkbookFormatProviderBase.FilesDescription

Name

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

Declaration

cs-api-definition
public override string Name { get; }

Property Value

string

The name of the provider.

Overrides WorkbookFormatProviderBase.Name

SupportedExtensions

Specifies that this provider handles files with .xlsx extension.

Declaration

cs-api-definition
public override IEnumerable<string> SupportedExtensions { get; }

Property Value

IEnumerable<string>

The supported extensions.

Overrides WorkbookFormatProviderBase.SupportedExtensions

Methods

ExportOverride(Workbook, Stream)

Exports the specified workbook.

Declaration

cs-api-definition
[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.

output

Stream

The output.

Overrides WorkbookFormatProviderBase.ExportOverride(Workbook, Stream)

ExportOverride(Workbook, Stream, CancellationToken)

Writes the workbook to the stream in XLSX format with license validation.

Declaration

cs-api-definition
protected override void ExportOverride(Workbook workbook, Stream output, CancellationToken cancellationToken)

Parameters

workbook

Workbook

The workbook.

output

Stream

The output.

cancellationToken

CancellationToken

The cancellation token used to cancel the operation.

Overrides WorkbookFormatProviderBase.ExportOverride(Workbook, Stream, CancellationToken)

ImportOverride(Stream)

Imports the specified input.

Declaration

cs-api-definition
[Obsolete("This method is obsolete. Please use ImportOverride(Stream input, CancellationToken cancellationToken) instead.")]
protected override Workbook ImportOverride(Stream input)

Parameters

input

Stream

The input.

Returns

Workbook

The imported workbook.

Overrides WorkbookFormatProviderBase.ImportOverride(Stream)

ImportOverride(Stream, CancellationToken)

Reads XLSX data from the stream and constructs a workbook with optimized formula caching enabled during import.

Declaration

cs-api-definition
protected override Workbook ImportOverride(Stream input, CancellationToken cancellationToken)

Parameters

input

Stream

The input.

cancellationToken

CancellationToken

The cancellation token used to cancel the operation.

Returns

Workbook

The imported workbook.

Overrides WorkbookFormatProviderBase.ImportOverride(Stream, CancellationToken)