Class BinaryWorkbookFormatProviderBase

Base class for format providers that import and export workbooks using binary formats such as XLSX and XLS.

Inheritance
System.Object
WorkbookFormatProviderBase
BinaryWorkbookFormatProviderBase
JsonFormatProvider
XlsmFormatProvider
XlsxFormatProvider
PdfFormatProvider
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
Assembly: Telerik.Windows.Documents.Spreadsheet.dll

Syntax

public abstract class BinaryWorkbookFormatProviderBase : WorkbookFormatProviderBase, IBinaryWorkbookFormatProvider, IWorkbookFormatProvider

Constructors

BinaryWorkbookFormatProviderBase()

Initializes a new instance of the BinaryWorkbookFormatProviderBase class.

Declaration
protected BinaryWorkbookFormatProviderBase()

Methods

Export(Workbook)

Exports the specified workbook to a byte array without timeout support.

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

The workbook.
Returns
System.Byte[]

The result byte array.
Implements

Export(Workbook, Nullable<TimeSpan>)

Exports the specified workbook to a byte array with optional timeout to prevent long-running operations.

Declaration
public byte[] Export(Workbook workbook, TimeSpan? timeout)
Parameters
Workbook workbook

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

The timeout after which the operation will be cancelled.
Returns
System.Byte[]

The result byte array.
Exceptions
System.ArgumentOutOfRangeException

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.

Import(Byte[])

Imports a workbook from the specified byte array without timeout support.

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

The input.
Returns
Workbook

The workbook.
Implements

Import(Byte[], Nullable<TimeSpan>)

Imports a workbook from the specified byte array with optional timeout to prevent long-running operations.

Declaration
public Workbook Import(byte[] input, TimeSpan? timeout)
Parameters
System.Byte[] input

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

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

The workbook.
Exceptions
System.ArgumentOutOfRangeException

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.