XtraReport.ExportOptions Property

Gets the settings used to specify exporting parameters when exporting a report.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.1.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

[SRCategory(ReportStringId.CatBehavior)]
public ExportOptions ExportOptions { get; }

VB.NET

<SRCategory(ReportStringId.CatBehavior)>
Public ReadOnly Property ExportOptions As ExportOptions

Property Value

Type	Description
ExportOptions	An ExportOptions object which contains the export settings for a report.

Remarks

Use the ExportOptions property to set the options which control how the current report is exported.

Example

This example demonstrates how to export a report to HTML format.

The project uses the XtraReport.ExportToHtml method with the HtmlExportOptions object as a parameter.

C#

using System;
using System.Diagnostics;
using System.Drawing;
using System.Windows.Forms;
using DevExpress.XtraPrinting;
// ...

private void ExportToHTML() {
    // A path to export a report.
    string reportPath = "c:\\Test.html";

    // Create a report instance.
    XtraReport1 report = new XtraReport1();

    // Get its HTML export options.
    HtmlExportOptions htmlOptions = report.ExportOptions.Html;

    // Set HTML-specific export options.
    htmlOptions.CharacterSet = "UTF-8";
    htmlOptions.TableLayout = false;
    htmlOptions.RemoveSecondarySymbols = false;
    htmlOptions.Title = "Test Title";

    // Set the pages to be exported, and page-by-page options.
    htmlOptions.ExportMode = HtmlExportMode.SingleFilePageByPage;
    htmlOptions.PageRange = "1, 3-5";
    htmlOptions.PageBorderColor = Color.Blue;
    htmlOptions.PageBorderWidth = 3;

    // Export the report to HTML.
    report.ExportToHtml(reportPath);

    // Show the result.
    StartProcess(reportPath);
}

// Call this method to automatically open the 
// created HTML file in the system's default program.
public void StartProcess(string path) {
    Process process = new Process();
    try {
        process.StartInfo.FileName = path;
        process.Start();
        process.WaitForInputIdle();
    }
    catch { }
}

VB.NET

Imports System
Imports System.Drawing
Imports System.Diagnostics
Imports DevExpress.XtraPrinting
Imports DevExpress.XtraReports.UI
' ...

Private Sub ExportToHTML()
    ' A path to export a report.
    Dim reportPath As String = "c:\\Test.html"

    ' Create a report instance.
    Dim report As New XtraReport1()

    ' Get its HTML export options.
    Dim htmlOptions As HtmlExportOptions = report.ExportOptions.Html

    ' Set HTML-specific export options.
    htmlOptions.CharacterSet = "UTF-8"
    htmlOptions.TableLayout = False
    htmlOptions.RemoveSecondarySymbols = False
    htmlOptions.Title = "Test Title"

    ' Set the pages to be exported, and page-by-page options.
    htmlOptions.ExportMode = HtmlExportMode.SingleFilePageByPage
    htmlOptions.PageRange = "1, 3-5"
    htmlOptions.PageBorderColor = Color.Blue
    htmlOptions.PageBorderWidth = 3

    ' Export the report to HTML.
    report.ExportToHtml(reportPath)

    ' Show the result.
    StartProcess(reportPath)
End Sub

' Call this method to automatically open the 
' created HTML file in the system's default program.
Public Sub StartProcess(ByVal path As String)
    Dim process As New Process()
    Try
        process.StartInfo.FileName = path
        process.Start()
        process.WaitForInputIdle()
    Catch
    End Try
End Sub