InterfaceIFormatProvider<T>
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:
T
Syntax:
public interface IFormatProvider<T>Derived Classes:
Properties
CanExport
Gets a value indicating whether this provider supports export.
Declaration
bool CanExport { get; }Property Value
The value indicating whether can export.
CanImport
Gets a value indicating whether this provider supports import.
Declaration
bool CanImport { get; }Property Value
The value indicating whether can import.
SupportedExtensions
Gets the file extensions supported by this provider.
Declaration
IEnumerable<string> SupportedExtensions { get; }Property Value
The supported extensions.
Methods
Export(T, Stream)
Exports the document to the output stream.
Declaration
[Obsolete("This method is obsolete. Please use Export(T document, Stream output, TimeSpan? timeout) instead.")]
void Export(T document, Stream output)Parameters
document
T
The document.
output
The output stream.
Export(T, Stream, TimeSpan?)
Exports the document to the output stream with an optional timeout.
Declaration
void Export(T document, Stream output, TimeSpan? timeout)Parameters
document
T
The document.
output
The output stream.
timeout
The timeout after which the operation will be cancelled.
Exceptions
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)
Imports a document from the input stream and returns the parsed document.
Declaration
[Obsolete("This method is obsolete. Please use Import(Stream input, TimeSpan? timeout) instead.")]
T Import(Stream input)Parameters
input
The input stream.
Returns
T
The imported document.
Import(Stream, TimeSpan?)
Imports a document from the input stream with an optional timeout and returns the parsed document.
Declaration
T Import(Stream input, TimeSpan? timeout)Parameters
input
The input stream.
timeout
The timeout after which the operation will be cancelled.
Returns
T
The imported document.
Exceptions
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.