Class TextFormatProvider

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

Inheritance

System.Object

TextFormatProvider

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

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

Assembly: Telerik.Windows.Documents.Fixed.dll

Syntax

public class TextFormatProvider

Constructors

TextFormatProvider()

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

Declaration

public TextFormatProvider()

Methods

Export(RadFixedDocument)

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

Declaration

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

Parameters

RadFixedDocument document The document to export.

Returns

System.String The text, that is extracted from the RadFixedDocument.

Export(RadFixedDocument, Nullable<TimeSpan>)

Exports the specified document as text.

Declaration

public string Export(RadFixedDocument document, TimeSpan? timeout)

Parameters

RadFixedDocument document The document to export.

System.Nullable<System.TimeSpan> timeout The timeout after which the operation will be cancelled.

Returns

System.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

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

Parameters

RadFixedDocument document The document to export.

TextFormatProviderSettings settings The settings.

Returns

System.String The text, that is extracted from the RadFixedDocument.

Export(RadFixedDocument, TextFormatProviderSettings, Nullable<TimeSpan>)

Exports the specified document as text.

Declaration

public string Export(RadFixedDocument document, TextFormatProviderSettings settings, TimeSpan? timeout)

Parameters

RadFixedDocument document The document to export.

TextFormatProviderSettings settings The settings.

System.Nullable<System.TimeSpan> timeout The timeout after which the operation will be cancelled.

Returns

System.String The text, that is extracted from the RadFixedDocument.