XtraReport.ExportToRtf(Stream, RtfExportOptions) Method

Exports a report to the specified stream in RTF format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.2.dll

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

Declaration

C#

public void ExportToRtf(
    Stream stream,
    RtfExportOptions options = null
)

VB.NET

Public Sub ExportToRtf(
    stream As Stream,
    options As RtfExportOptions = Nothing
)

Parameters

Name	Type	Description
stream	Stream	A Stream for output data.

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.

Use the ExportToRtfAsync(Stream, 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.

Note

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

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 snippet (auto-collected from DevExpress Examples) contains a reference to the ExportToRtf(Stream, RtfExportOptions) 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-winforms-export-doc-odt/CS/WindowsFormsApplication1/Form1.cs#L65

using (MemoryStream ms = new MemoryStream()) {
    report.ExportToRtf(ms, new RtfExportOptions() { ExportMode = RtfExportMode.SingleFile });
    ms.Position = 0;

VB.NET

reporting-winforms-export-doc-odt/VB/WindowsFormsApplication1/Form1.vb#L62

Using ms As MemoryStream = New MemoryStream()
    report.ExportToRtf(ms, New RtfExportOptions() With {.ExportMode = RtfExportMode.SingleFile})
    ms.Position = 0