XtraReport.ExportToRtf(Stream, RtfExportOptions) Method

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

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v18.2.dll

Declaration

C#

public void ExportToRtf(
    Stream stream,
    RtfExportOptions options
)

VB.NET

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

Parameters

Name	Type	Description
stream	Stream	A Stream object to which the created RTF file should be sent.
options	RtfExportOptions	An RtfExportOptions object, containing RTF export settings.

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.

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.

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_how-to-export-an-xtrareport-document-to-doc-docx-and-odt-file-formats-e4530/CS/WindowsFormsApplication1/Form1.cs#L65

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

VB.NET

Reporting_how-to-export-an-xtrareport-document-to-doc-docx-and-odt-file-formats-e4530/VB/WindowsFormsApplication1/Form1.vb#L65

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