Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

XtraReport.ExportToRtf(String, RtfExportOptions) Method

Exports a report to the specified file in RTF format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.2.dll

NuGet Package: DevExpress.Reporting.Core

#Declaration

public void ExportToRtf(
    string path,
    RtfExportOptions options = null
)

#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 file in RTF format with the specified RTF export options.

If you do not specify export options, the method uses the current report export options. To access the report export options, use the XtraReport.ExportOptions.Rtf notation.

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.

#Example

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.

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