HtmlExportOptionsBase.ExportMode Property

Gets or sets a value indicating how a document is exported to HTML.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v20.2.Core.dll

NuGet Packages: DevExpress.Printing.Core, DevExpress.WindowsDesktop.Printing.Core

Declaration

C#

[DefaultValue(HtmlExportMode.SingleFile)]
public HtmlExportMode ExportMode { get; set; }

VB.NET

<DefaultValue(HtmlExportMode.SingleFile)>
Public Property ExportMode As HtmlExportMode

Property Value

Type	Default	Description
HtmlExportMode	**SingleFile**	An HtmlExportMode enumeration value which represents the HTML export mode.

Available values:

Name	Description
SingleFile	A document is exported to a single file. Note that in this mode, page headers and footers are added to the resulting HTML file only once, at the beginning and at the end of the document.
SingleFilePageByPage	A document is exported to a single file, page-by-page. In this mode, all pages are exported one under another, separated by page borders (which are specified by the HtmlExportOptionsBase.PageBorderWidth and HtmlExportOptionsBase.PageBorderColor properties).
DifferentFiles	A document is exported to multiple files, page-by-page. In this mode every document page is exported to a single HTML file.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to ExportMode
Cross-Platform Class Library	ExportOptions	.Html .ExportMode
WPF Controls	ExportOptionsContainer	.Html .ExportMode

Remarks

The values listed in the HtmlExportMode enumeration specify the way in which a document is exported to HTML. For instance, it may be exported to a single file with a single page header at the beginning, and a single page footer at the end. Otherwise, it may be exported page-by-page, to either a single file, or different files. Note that if a document is exported page-by-page, you may specify the appearance of page borders via the HtmlExportOptionsBase.PageBorderWidth and HtmlExportOptionsBase.PageBorderColor properties.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ExportMode 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#

XAF_how-to-customize-export-options-of-the-printing-system-in-winforms-e2108/CS/WinSolution.Module.Win/ConfigurePrintingSystemViewController.cs#L52

htmlExportOptions.Title = "CustomHtmlTitle";
htmlExportOptions.ExportMode = HtmlExportMode.SingleFilePageByPage;
htmlExportOptions.PageBorderColor = System.Drawing.Color.Gray;

VB.NET

XAF_how-to-customize-export-options-of-the-printing-system-in-winforms-e2108/VB/WinSolution.Module.Win/ConfigurePrintingSystemViewController.vb#L53

htmlExportOptions.Title = "CustomHtmlTitle"
htmlExportOptions.ExportMode = HtmlExportMode.SingleFilePageByPage
htmlExportOptions.PageBorderColor = System.Drawing.Color.Gray