XtraReport.ExportToRtf(String) Method

Exports a report to the specified file path in RTF format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

C#

public void ExportToRtf(
    string path
)

VB.NET

Public Sub ExportToRtf(
    path As String
)

Parameters

Name	Type	Description
path	String	A String which specifies the file name (including the full path) for the created RTF file.

Remarks

Once the document export has started, it will run until the resulting document is complete and cannot be interrupted or canceled in the process.

Use this method to export a report to an RTF file using its current RTF-specific export options. These options are represented by the RtfExportOptions object returned by the ExportOptions.Rtf property of a report’s XtraReport.ExportOptions.

Note

This method overwrites any files present at the specified path that have the same file name without any warnings.

Note

For more information on using the ExportToRtf method, and limitations on export to RTF, please refer to the Export to RTF document.

Example

The following example demonstrates how to export a report to RTF format. To do this, the XtraReport.ExportToRtf method should be used.

For this example to work, you first need to add a new report (named XtraReport1) to your project, drop some report controls onto it, and then execute the code below (for instance, in the Button.Click event handler of any button on a form). Note also, that if you want the resulting file to be automatically opened in the default program which is used to open *.rtf files in your system, you can call the StartProcess method, which is also shown in this example.

Tip

Online Example: How to export a report to RTF format

C#

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 { }
}

VB.NET

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

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

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

    ' Export the report to RTF.
    report.ExportToRtf(reportPath)

    ' Show the result.
    StartProcess(reportPath)
End Sub

' Use this method if you want to automaically open
' the created RTF file in the 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

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ExportToRtf(String) method.

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#

Reporting_report-building-basics-e925/CS/Form1.cs#L69

    // Export the report to RTF.
    report.ExportToRtf("report.rtf");
}

Reporting_how-to-export-a-report-to-rtf-format-e99/CS/Form1.cs#L27

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

VB.NET

Reporting_report-building-basics-e925/VB/Form1.vb#L71

    ' Export the report to RTF.
    report.ExportToRtf("report.rtf")
End Sub

Reporting_how-to-export-a-report-to-rtf-format-e99/VB/Form1.vb#L17

' Export the report to RTF.
report.ExportToRtf(reportPath)