HtmlDocumentExporterOptions Class

Contains options to export the document in HTML format.

Namespace: DevExpress.XtraRichEdit.Export

Assembly: DevExpress.RichEdit.v24.1.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#
VB.NET

[ComVisible(true)]
public class HtmlDocumentExporterOptions :
    DocumentExporterOptions

<ComVisible(True)>
Public Class HtmlDocumentExporterOptions
    Inherits DocumentExporterOptions

The following members return HtmlDocumentExporterOptions objects:

Remarks

Use the HtmlDocumentExporterOptions class object in the following members:

In the BeforeExport event handler.
As the SubDocument.GetHtmlText method parameter.

For a list of supported HTML tags, refer to the following help topic: HTML Tag Support.

Example

The following code snippet illustrates how to obtain HTML text using the SubDocument.GetHtmlText method specifying export options with the HtmlDocumentExporterOptions object.

View Example

Form1.cs
Form1.vb

    frmBrowser myBrowser = new frmBrowser();
    DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions myExportOptions =
        new DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions();
    myExportOptions.Encoding = System.Text.Encoding.Unicode;

    if (this.richEditControl.Document.Selection.Length > 0) {
        DevExpress.XtraRichEdit.API.Native.DocumentRange selection = richEditControl.Document.Selection;
        DevExpress.XtraRichEdit.API.Native.SubDocument doc = selection.BeginUpdateDocument();
        myBrowser.SetHtml(doc.GetHtmlText(selection, null, myExportOptions));
        selection.EndUpdateDocument(doc);
    }
    else {
        myBrowser.SetHtml(richEditControl.Document.GetHtmlText(richEditControl.Document.Range, null, myExportOptions));
    }

    myBrowser.Show();
}

Private Sub btnHtmlOptions_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnHtmlOptions.Click
    Dim myBrowser As New frmBrowser()
    Dim myExportOptions As New DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions()
    myExportOptions.Encoding = System.Text.Encoding.Unicode

    If Me.richEditControl.Document.Selection.Length > 0 Then
        Dim selection As DevExpress.XtraRichEdit.API.Native.DocumentRange = richEditControl.Document.Selection
        Dim doc As DevExpress.XtraRichEdit.API.Native.SubDocument = selection.BeginUpdateDocument()
        myBrowser.SetHtml(doc.GetHtmlText(selection, Nothing, myExportOptions))
        selection.EndUpdateDocument(doc)
    Else
        myBrowser.SetHtml(richEditControl.Document.GetHtmlText(richEditControl.Document.Range, Nothing, myExportOptions))
    End If

    myBrowser.Show()
End Sub