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

IFormatProvider<T>

Interface

Contract for format providers that import/export documents via streams and expose capabilities and extensions.

Definition

Namespace:Telerik.Windows.Documents.Common.FormatProviders

Assembly:Telerik.Windows.Documents.Core.dll

Type Parameters:

Syntax:

public interface IFormatProvider<T>

Derived Classes: BinaryFormatProviderBase<T>FormatProviderBase<T>TextBasedFormatProviderBase<T>OcrFormatProviderPdfFormatProviderDocFormatProviderDocxFormatProviderHtmlFormatProviderMarkdownFormatProviderPdfFormatProviderRtfFormatProviderTxtFormatProvider...

Properties

CanExport

bool

Gets a value indicating whether this provider supports export.

bool CanExport { get; }

Property Value:

The value indicating whether can export.

CanImport

bool

Gets a value indicating whether this provider supports import.

bool CanImport { get; }

Property Value:

The value indicating whether can import.

SupportedExtensions

IEnumerable<string>

Gets the file extensions supported by this provider.

IEnumerable<string> SupportedExtensions { get; }

Property Value:

The supported extensions.

Methods

Export(T, Stream, TimeSpan?)

Exports the document to the output stream with an optional timeout.

void Export(T document, Stream output, TimeSpan? timeout)

Parameters:documentT

The document.

outputStream

The output stream.

timeoutTimeSpan?

The timeout after which the operation will be cancelled.

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.

Import(Stream, TimeSpan?)

Imports a document from the input stream with an optional timeout and returns the parsed document.

T Import(Stream input, TimeSpan? timeout)

Parameters:inputStream

The input stream.

timeoutTimeSpan?

The timeout after which the operation will be cancelled.

Returns:

The imported document.

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.