New to Telerik Document Processing? Start a free 30-day trial

BinaryFormatProviderBase<T>

Class

Base for binary format providers that import/export documents from/to byte arrays and streams.

Definition

Namespace:Telerik.Windows.Documents.Common.FormatProviders

Assembly:Telerik.Windows.Documents.Core.dll

Type Parameters:

The type of the document.

Syntax:

public abstract class BinaryFormatProviderBase<T> : FormatProviderBase<T>, IFormatProvider<T>, IBinaryFormatProvider<T>

Inheritance: objectFormatProviderBase<T>BinaryFormatProviderBase<T>

Derived Classes: OcrFormatProviderPdfFormatProviderDocFormatProviderDocxFormatProviderPdfFormatProvider

Implements: IBinaryFormatProvider<T>IFormatProvider<T>

Inherited Members FormatProviderBase<T>.Import(Stream, TimeSpan?)FormatProviderBase<T>.Export(T, Stream, TimeSpan?)FormatProviderBase<T>.ImportOverride(Stream, CancellationToken)FormatProviderBase<T>.ExportOverride(T, Stream, CancellationToken)FormatProviderBase<T>.SupportedExtensionsFormatProviderBase<T>.CanImportFormatProviderBase<T>.CanExport...

Constructors

BinaryFormatProviderBase()

protected BinaryFormatProviderBase()

Methods

Export(T, TimeSpan?)

Exports the document to a byte array with an optional timeout.

public byte[] Export(T document, TimeSpan? timeout)

Parameters:documentT

The document.

timeoutTimeSpan?

The timeout after which the operation will be cancelled.

Returns:

byte[]

Exceptions:

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.

Implements: IBinaryFormatProvider<T>.Export(T, TimeSpan?)

Import(byte[], TimeSpan?)

Imports a document from a byte array with an optional timeout and returns the parsed document.

[SuppressMessage("Microsoft.Reliability", "CA2000:Dispose objects before losing scope")]
public T Import(byte[] input, TimeSpan? timeout)

Parameters:inputbyte[]

The input.