Class HtmlFormatProvider

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

Inheritance
System.Object
DocumentFormatProviderBase
HtmlFormatProvider
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.WinForms.Documents.FormatProviders.Html
Assembly: Telerik.WinControls.RichTextEditor.dll

Syntax

public class HtmlFormatProvider : DocumentFormatProviderBase, IConfigurableHtmlFormatProvider, ITextBasedDocumentFormatProvider, IValidateDocumentFormatProvider, IDocumentFormatProvider

Constructors

HtmlFormatProvider()

Initializes a new instance of the HtmlFormatProvider class.

Declaration
public HtmlFormatProvider()

Properties

CanExport

Gets a value indicating whether this instance can export.

Declaration
public override bool CanExport { get; }
Property Value
System.Boolean

true if this instance can export; otherwise, false.
Overrides
Implements

CanImport

Gets a value indicating whether this instance can import.

Declaration
public override bool CanImport { get; }
Property Value
System.Boolean

true if this instance can import; otherwise, false.
Overrides
Implements

ExportSettings

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

Declaration
public HtmlExportSettings ExportSettings { get; set; }
Property Value
HtmlExportSettings

The export settings.
Implements

FilesDescription

Gets the description of the supported file formats.

Declaration
public override string FilesDescription { get; }
Property Value
System.String

The files description.
Overrides
Implements

ImportSettings

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

Declaration
public HtmlImportSettings ImportSettings { get; set; }
Property Value
HtmlImportSettings

The import settings.
Implements

Name

Gets the name of the specific format provider.

Declaration
public override string Name { get; }
Property Value
System.String

The name.
Overrides
Implements

SupportedExtensions

Gets the extensions supported by this format provider.

Declaration
public override IEnumerable<string> SupportedExtensions { get; }
Property Value
System.Collections.Generic.IEnumerable<System.String>

The supported extensions.
Overrides
Implements

Methods

Export(RadDocument)

Exports the specified RadDocument instance to a System.String.

Declaration
public string Export(RadDocument document)
Parameters
RadDocument document

The document which should be exported.
Returns
System.String

A System.String containing the HTML document.
Implements

Export(RadDocument, Stream)

Exports the specified RadDocument instance.

Declaration
public override void Export(RadDocument document, Stream output)
Parameters
RadDocument document

The document.
System.IO.Stream output

The System.IO.Stream the document should be saved into.
Overrides
Implements

Import(Stream)

Imports the specified System.IO.Stream into a RadDocument instance.

Declaration
public override RadDocument Import(Stream input)
Parameters
System.IO.Stream input

The System.IO.Stream containing the document data.
Returns
RadDocument

The generated RadDocument instance.
Overrides
Implements

Import(String)

Imports the specified System.String into a RadDocument instance.

Declaration
public RadDocument Import(string input)
Parameters
System.String input

The HTML string.
Returns
RadDocument

The generated RadDocument instance.
Implements

Extension Methods