New to Telerik UI for WinForms? Start a free 30-day trial

TxtFormatProvider

Class

Represents a format provider that can import and export plain text documents from/to RadDocument.

Definition

Namespace:Telerik.WinForms.Documents.FormatProviders.Txt

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

public class TxtFormatProvider : DocumentFormatProviderBase, ITextBasedDocumentFormatProvider, IDocumentFormatProvider

Inheritance: objectDocumentFormatProviderBaseTxtFormatProvider

Implements: IDocumentFormatProviderITextBasedDocumentFormatProvider

Inherited Members DocumentFormatProviderBase.Import(byte[])

Constructors

TxtFormatProvider()

public TxtFormatProvider()

Properties

CanExport

bool

Gets a value indicating whether this instance can export.

public override bool CanExport { get; }

Property Value:

true if this instance can export; otherwise, false.

Overrides: DocumentFormatProviderBase.CanExport

Implements: IDocumentFormatProvider.CanExport

CanImport

bool

Gets a value indicating whether this instance can import.

public override bool CanImport { get; }

Property Value:

true if this instance can import; otherwise, false.

Overrides: DocumentFormatProviderBase.CanImport

Implements: IDocumentFormatProvider.CanImport

FilesDescription

string

Gets the description of the supported file formats.

public override string FilesDescription { get; }

Property Value:

The files description.

Overrides: DocumentFormatProviderBase.FilesDescription

Implements: IDocumentFormatProvider.FilesDescription

Name

string

Gets the name of the specific format provider.

public override string Name { get; }

Property Value:

The name.

Overrides: DocumentFormatProviderBase.Name

Implements: IDocumentFormatProvider.Name

SupportedExtensions

IEnumerable<string>

Gets the extensions supported by this format provider.

public override IEnumerable<string> SupportedExtensions { get; }

Property Value:

The supported extensions.

Overrides: DocumentFormatProviderBase.SupportedExtensions

Implements: IDocumentFormatProvider.SupportedExtensions

Methods

Export(RadDocument, Stream)

Exports the specified RadDocument instance to plain text.

public override void Export(RadDocument document, Stream output)

Parameters:documentRadDocument

The document.

outputStream

The Stream the document should be saved into.

Overrides: DocumentFormatProviderBase.Export(RadDocument, Stream)

Implements: IDocumentFormatProvider.Export(RadDocument, Stream)

Export(RadDocument)

Exports the specified document to a string.

public string Export(RadDocument document)

Parameters:documentRadDocument

The document.

Returns:

string

A string containing the document.

Implements: ITextBasedDocumentFormatProvider.Export(RadDocument)

Import(Stream)

Imports the specified Stream into a RadDocument instance.

public override RadDocument Import(Stream input)

Parameters:inputStream

The Stream containing the document data.

Returns:

RadDocument

The generated RadDocument instance.

Overrides: DocumentFormatProviderBase.Import(Stream)

Implements: IDocumentFormatProvider.Import(Stream)

Import(string)

Imports the specified string.

public RadDocument Import(string input)

Parameters:inputstring

The string containing the document.

Returns:

RadDocument

The generated RadDocument instance.

Implements: ITextBasedDocumentFormatProvider.Import(string)