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

HtmlFormatProvider

Class

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

Definition

Namespace:Telerik.WinForms.Documents.FormatProviders.Html

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

public class HtmlFormatProvider : DocumentFormatProviderBase, IConfigurableHtmlFormatProvider, ITextBasedDocumentFormatProvider, IDocumentFormatProvider

Inheritance: objectDocumentFormatProviderBaseHtmlFormatProvider

Implements: IConfigurableHtmlFormatProviderIDocumentFormatProviderITextBasedDocumentFormatProvider

Inherited Members DocumentFormatProviderBase.Import(byte[])

Constructors

HtmlFormatProvider()

Initializes a new instance of the HtmlFormatProvider class.

public HtmlFormatProvider()

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

ExportSettings

HtmlExportSettings

Gets or sets the settings which will be used while exporting a document.

public HtmlExportSettings ExportSettings { get; set; }

Property Value:

The export settings.

Implements: IConfigurableHtmlFormatProvider.ExportSettings

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

ImportSettings

HtmlImportSettings

Gets or sets the settings which will be used while importing a document.

public HtmlImportSettings ImportSettings { get; set; }

Property Value:

The import settings.

Implements: IConfigurableHtmlFormatProvider.ImportSettings

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.

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 RadDocument instance to a string.

public string Export(RadDocument document)

Parameters:documentRadDocument

The document which should be exported.

Returns:

string

A string containing the HTML 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 into a RadDocument instance.

public RadDocument Import(string input)

Parameters:inputstring

The HTML string.

Returns:

RadDocument

The generated RadDocument instance.

Implements: ITextBasedDocumentFormatProvider.Import(string)