HtmlDocumentExporterOptions.HtmlNumberingListExportFormat Property

Gets or sets how the lists are represented in the resulting document.

Namespace: DevExpress.XtraRichEdit.Export

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

Declaration

C#

public HtmlNumberingListExportFormat HtmlNumberingListExportFormat { get; set; }

VB.NET

Public Property HtmlNumberingListExportFormat As HtmlNumberingListExportFormat

Property Value

Type	Description
HtmlNumberingListExportFormat	A HtmlNumberingListExportFormat enumeration value specifying how the lists are exported.

Available values:

Name	Description
PlainTextFormat	Uses characters to mark lists.
HtmlFormat	Uses HTML tags to mark lists.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to HtmlNumberingListExportFormat
WinForms Controls	RichTextEditDocumentExportOptions	.Mht.HtmlNumberingListExportFormat
Office File API	RichEditDocumentExportOptions	.Mht.HtmlNumberingListExportFormat

Remarks

Handle the RichEditControl.BeforeExport and RichEditDocumentServer.BeforeExport event and specify the list representation - that is, whether HTML tags like <li> are used, - via the BeforeExportEventArgs.Options property of the event arguments.

The following code snippet illustrates this:

Note

A complete sample project is available at How to save the text of a document range in different formats.

C#

private void richEditControl_BeforeExport(object sender, DevExpress.XtraRichEdit.BeforeExportEventArgs e) {
    DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions options = e.Options as DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions;
    if (options != null) 
{
        options.CssPropertiesExportType = DevExpress.XtraRichEdit.Export.Html.CssPropertiesExportType.Link;
        options.HtmlNumberingListExportFormat = DevExpress.XtraRichEdit.Export.Html.HtmlNumberingListExportFormat.HtmlFormat;
        options.TargetUri = Path.GetFileNameWithoutExtension(this.fileName);
    }
}

VB.NET

Private Sub richEditControl_BeforeExport(ByVal sender As Object, ByVal e As DevExpress.XtraRichEdit.BeforeExportEventArgs)
    Dim options As DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions = TryCast(e.Options, DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions)
    If options IsNot Nothing Then
        options.CssPropertiesExportType = DevExpress.XtraRichEdit.Export.Html.CssPropertiesExportType.Link
        options.HtmlNumberingListExportFormat = DevExpress.XtraRichEdit.Export.Html.HtmlNumberingListExportFormat.HtmlFormat
        options.TargetUri = Path.GetFileNameWithoutExtension(Me.fileName)
    End If
End Sub

Related GitHub Examples

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

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#

dxrichedit-for-wpf-how-to-save-the-text-of-a-document-range-in-different-formats-e3267/CS/MainWindow.xaml.cs#L91

options.CssPropertiesExportType = CssPropertiesExportType.Link;
options.HtmlNumberingListExportFormat = HtmlNumberingListExportFormat.HtmlFormat;
options.TargetUri = System.IO.Path.GetFileNameWithoutExtension(this.fileName);

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

options.CssPropertiesExportType = DevExpress.XtraRichEdit.Export.Html.CssPropertiesExportType.Link;
options.HtmlNumberingListExportFormat = DevExpress.XtraRichEdit.Export.Html.HtmlNumberingListExportFormat.HtmlFormat;
options.TargetUri = Path.GetFileNameWithoutExtension(this.fileName);

word-document-api-examples/CS/CodeExamples/ExportActions.cs#L124

options.CssPropertiesExportType = DevExpress.XtraRichEdit.Export.Html.CssPropertiesExportType.Link;
options.HtmlNumberingListExportFormat = DevExpress.XtraRichEdit.Export.Html.HtmlNumberingListExportFormat.HtmlFormat;
options.TargetUri = "Document_HTML.html";

VB.NET

dxrichedit-for-wpf-how-to-save-the-text-of-a-document-range-in-different-formats-e3267/VB/MainWindow.xaml.vb#L93

options.CssPropertiesExportType = CssPropertiesExportType.Link
options.HtmlNumberingListExportFormat = HtmlNumberingListExportFormat.HtmlFormat
options.TargetUri = System.IO.Path.GetFileNameWithoutExtension(Me.fileName)

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

options.CssPropertiesExportType = DevExpress.XtraRichEdit.Export.Html.CssPropertiesExportType.Link
options.HtmlNumberingListExportFormat = DevExpress.XtraRichEdit.Export.Html.HtmlNumberingListExportFormat.HtmlFormat
options.TargetUri = Path.GetFileNameWithoutExtension(Me.fileName)

word-document-api-examples/VB/CodeExamples/ExportActions.vb#L108

options.CssPropertiesExportType = DevExpress.XtraRichEdit.Export.Html.CssPropertiesExportType.Link
options.HtmlNumberingListExportFormat = DevExpress.XtraRichEdit.Export.Html.HtmlNumberingListExportFormat.HtmlFormat
options.TargetUri = "Document_HTML.html"