HtmlDocumentExporterOptions Class

Contains options for exporting the document in HTML format.

Namespace: DevExpress.XtraRichEdit.Export

Assembly: DevExpress.RichEdit.v18.2.Core.dll

Declaration

C#
VB.NET

[ComVisible(true)]
public class HtmlDocumentExporterOptions :
    DocumentExporterOptions

<ComVisible(True)>
Public Class HtmlDocumentExporterOptions
    Inherits DocumentExporterOptions

The following members return HtmlDocumentExporterOptions objects:

Remarks

Create the HtmlDocumentExporterOptions instance and specify it as the SubDocument.GetHtmlText method parameter or handle the RichEditControl.BeforeExport or RichEditDocumentServer.BeforeExport event to specify HTML export options using the BeforeExportEventArgs.Options property of the event arguments.

For a list of supported HTML tags see the HTML Tag Support document.

Example

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

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-save-the-text-of-a-document-range-in-different-formats-e1604

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

The following code snippets (auto-collected from DevExpress Examples) contain references to the HtmlDocumentExporterOptions class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#
VB.NET

how-to-save-the-text-of-a-document-range-in-different-formats-e1604/CS/GetTextMethodsExample/Form1.cs#L85

frmBrowser myBrowser = new frmBrowser();
DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions myExportOptions =
    new DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions();

export-to-html-how-to-export-only-body-tag-content-and-specify-the-location-of-css-styles-e1726/CS/ExportOnlyBodyContent/Form1.cs#L116

stringHtml = String.Empty;
HtmlDocumentExporterOptions options = new HtmlDocumentExporterOptions();
options.ExportRootTag = htmlExportType;

how-to-retain-original-image-uri-in-html-document-e3189/CS/HTML_Export_ImageSourceExample/Form1.cs#L28

private void ReloadHtml() {
    DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions exportOptions = new DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions();
    exportOptions.EmbedImages = embedImagesCheck.Checked;

how-to-save-the-text-of-a-document-range-in-different-formats-e1604/VB/GetTextMethodsExample/Form1.vb#L66

Dim myBrowser As New frmBrowser()
Dim myExportOptions As New DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions()
myExportOptions.Encoding = System.Text.Encoding.Unicode

export-to-html-how-to-export-only-body-tag-content-and-specify-the-location-of-css-styles-e1726/VB/ExportOnlyBodyContent/Form1.vb#L119

stringHtml = String.Empty
Dim options As New HtmlDocumentExporterOptions()
options.ExportRootTag = htmlExportType

how-to-retain-original-image-uri-in-html-document-e3189/VB/HTML_Export_ImageSourceExample/Form1.vb#L27

Private Sub ReloadHtml()
    Dim exportOptions As New DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions()
    exportOptions.EmbedImages = embedImagesCheck.Checked