InterfaceITextBasedFormatProvider<T>
Contract for text-based format providers that import/export documents from/to strings.
Definition
Namespace:Telerik.Windows.Documents.Common.FormatProviders
Assembly:Telerik.Windows.Documents.Core.dll
Type Parameters:
T
Syntax:
public interface ITextBasedFormatProvider<T>Derived Classes:
Methods
Export(T)
Exports the document to a text string representation.
Declaration
string Export(T document)Parameters
document
T
The document.
Returns
The result string.
Export(T, TimeSpan?)
Exports the document to a text string with an optional timeout.
Declaration
string Export(T document, TimeSpan? timeout)Parameters
document
T
The document.
timeout
The timeout after which the operation will be cancelled.
Returns
The result string.
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(string)
Imports a document from a text string and returns the parsed document instance.
Declaration
T Import(string input)Parameters
input
The input.
Returns
T
The document.
Import(string, TimeSpan?)
Imports a document from a text string with an optional timeout and returns the parsed document.
Declaration
T Import(string input, TimeSpan? timeout)Parameters
input
The input.
timeout
The timeout after which the operation will be cancelled.
Returns
T
The 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.