Class
TextFormatProvider

Converts a RadFixedDocument to plain text using configurable line and page separators.

Definition

Namespace:Telerik.Windows.Documents.Fixed.FormatProviders.Text

Assembly:Telerik.Windows.Documents.Fixed.dll

Syntax:

cs-api-definition
public class TextFormatProvider

Inheritance: objectTextFormatProvider

Constructors

TextFormatProvider()

Create a text export provider for converting a fixed document into plain text with configurable separators.

Declaration

cs-api-definition
public TextFormatProvider()

Methods

Export(RadFixedDocument)

Exports the document to plain text using the default separators and returns the resulting string.

Declaration

cs-api-definition
[Obsolete("This method is obsolete. Please use Export(RadFixedDocument document, TimeSpan? timeout) instead.")]
public string Export(RadFixedDocument document)

Parameters

document

RadFixedDocument

The document to export.

Returns

string

The text, that is extracted from the RadFixedDocument.

Export(RadFixedDocument, TextFormatProviderSettings)

Exports the document to plain text using the provided settings and returns the resulting string.

Declaration

cs-api-definition
[Obsolete("This method is obsolete. Please use Export(RadFixedDocument document, TextFormatProviderSettings settings, TimeSpan? timeout) instead.")]
public string Export(RadFixedDocument document, TextFormatProviderSettings settings)

Parameters

document

RadFixedDocument

The document to export.

settings

TextFormatProviderSettings

The settings.

Returns

string

The text, that is extracted from the RadFixedDocument.

Export(RadFixedDocument, TextFormatProviderSettings, TimeSpan?)

Exports the specified document as text.

Declaration

cs-api-definition
public string Export(RadFixedDocument document, TextFormatProviderSettings settings, TimeSpan? timeout)

Parameters

document

RadFixedDocument

The document to export.

settings

TextFormatProviderSettings

The settings.

timeout

TimeSpan?

The timeout after which the operation will be cancelled.

Returns

string

The text, that is extracted from the RadFixedDocument.

Export(RadFixedDocument, TimeSpan?)

Exports the specified document as text.

Declaration

cs-api-definition
public string Export(RadFixedDocument document, TimeSpan? timeout)

Parameters

document

RadFixedDocument

The document to export.

timeout

TimeSpan?

The timeout after which the operation will be cancelled.

Returns

string

The text, that is extracted from the RadFixedDocument.