XtraReport.ExportToRtf(String, RtfExportOptions) Method

Exports a report to the specified file in RTF format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.1.dll

Declaration

public void ExportToRtf(
    string path,
    RtfExportOptions options = null
)
Public Sub ExportToRtf(
    path As String,
    options As RtfExportOptions = Nothing
)

Parameters

Name Type Description
path String

The path to the exported PDF file.

Optional Parameters

Name Type Default Description
options RtfExportOptions

null

The RTF export options. You can omit this parameter to use the current report export options.

Remarks

NOTE

Once the document export has started, it runs to completion and you cannot interrupt or cancel it.

This method exports a report to a RTF file with the specified RTF export options.

If the export options are not specified, the current report export options are used. To access the report export options, use the the report's XtraReport.ExportOptions property. The property contains the ExportOptions object whose ExportOptions.Rtf property provides access to the RtfExportOptions object that contains the RTF export options.

IMPORTANT

This method overwrites files with the same name without confirmation.

Use the ExportToRtfAsync(String, RtfExportOptions, CancellationToken) method instead of ExportToRtf to export a report asynchronously in a separate task.

Examples

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

The project uses the XtraReport.ExportToRtf method with the RtfExportOptions object as a parameter.

NOTE

The complete sample project How to export a report to RTF format is available in the DevExpress Examples repository.

using System.Diagnostics;
using DevExpress.XtraPrinting;
using DevExpress.XtraReports.UI;
// ...

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

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

    // Export the report to RTF.
    report.ExportToRtf(reportPath);

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

// Use this method if you want to automaically open
// the created RTF file in the default program.
public void StartProcess(string path)
{
    Process process = new Process();
    try
    {
        process.StartInfo.FileName = path;
        process.Start();
        process.WaitForInputIdle();
    }
    catch { }
}
See Also