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

DocumentFormatProviderBase

Class

A base class defining members for importing and exporting content to/from RadDocument.

Definition

Namespace:Telerik.WinForms.Documents.FormatProviders

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

public abstract class DocumentFormatProviderBase : IDocumentFormatProvider

Inheritance: objectDocumentFormatProviderBase

Derived Classes: HtmlFormatProviderDocxFormatProviderPdfFormatProviderRtfFormatProviderTxtFormatProviderXamlFormatProvider...

Implements: IDocumentFormatProvider

Constructors

DocumentFormatProviderBase()

protected DocumentFormatProviderBase()

Properties

CanExport

bool

Gets a value indicating whether this instance can export.

public abstract bool CanExport { get; }

Property Value:

true if this instance can export; otherwise, false.

Implements: IDocumentFormatProvider.CanExport

CanImport

bool

Gets a value indicating whether this instance can import.

public abstract bool CanImport { get; }

Property Value:

true if this instance can import; otherwise, false.

Implements: IDocumentFormatProvider.CanImport

FilesDescription

string

Gets the description of the supported file formats.

public virtual string FilesDescription { get; }

Property Value:

The files description.

Implements: IDocumentFormatProvider.FilesDescription

Name

string

Gets the name of the specific format provider.

public abstract string Name { get; }

Property Value:

The name.

Implements: IDocumentFormatProvider.Name

SupportedExtensions

IEnumerable<string>

Gets the extensions supported by this format provider.

public abstract IEnumerable<string> SupportedExtensions { get; }

Property Value:

The supported extensions.

Implements: IDocumentFormatProvider.SupportedExtensions

Methods

Export(RadDocument, Stream)

Exports the specified RadDocument instance.

public abstract void Export(RadDocument document, Stream output)

Parameters:documentRadDocument

The document.

outputStream

The Stream the document should be saved into.

Implements: IDocumentFormatProvider.Export(RadDocument, Stream)

Export(RadDocument)

Exports the specified document to a byte array.

public virtual byte[] Export(RadDocument document)

Parameters:documentRadDocument

The document.

Returns:

byte[]

A byte array containing the document data.

Implements: IDocumentFormatProvider.Export(RadDocument)

Import(byte[])

Imports the specified byte array into a RadDocument instance.

public virtual RadDocument Import(byte[] input)

Parameters:inputbyte[]

The byte array containing the document data.

Returns:

RadDocument

The generated RadDocument instance.

Implements: IDocumentFormatProvider.Import(byte[])

Import(Stream)

Imports the specified Stream into a RadDocument instance.

public abstract RadDocument Import(Stream input)

Parameters:inputStream

The Stream containing the document data.

Returns:

RadDocument

The generated RadDocument instance.

Implements: IDocumentFormatProvider.Import(Stream)