XtraReport.ExportToText(Stream, TextExportOptions) Method

Exports a report to the specified stream in text format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v24.1.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public void ExportToText(
    Stream stream,
    TextExportOptions options = null
)

VB.NET

Public Sub ExportToText(
    stream As Stream,
    options As TextExportOptions = Nothing
)

Parameters

Name	Type	Description
stream	Stream	A Stream for output data.

Optional Parameters

Name	Type	Default	Description
options	TextExportOptions	null	The text 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 text format with the specified text 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.Text notation.

Use the ExportToTextAsync(Stream, TextExportOptions, CancellationToken) method instead of ExportToText to export a report asynchronously in a separate task.

Example

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

The project uses the XtraReport.ExportToText method with the TextExportOptions object as a parameter.

C#

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

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

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

    // Get its Text export options.
    TextExportOptions txtOptions = report.ExportOptions.Text;

    // Set Text-specific export options.
    txtOptions.Encoding = Encoding.Unicode;
    txtOptions.Separator = CultureInfo.CurrentCulture.TextInfo.ListSeparator.ToString();

    // Export the report to Text.
    report.ExportToText(reportPath);

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

// Use this method if you want to automaically open
// the created Text 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.Text
Imports System.Diagnostics
Imports System.Globalization
Imports DevExpress.XtraPrinting
Imports DevExpress.XtraReports.UI
' ...

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

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

    ' Get its Text export options.
    Dim txtOptions As TextExportOptions = report.ExportOptions.Text

    ' Set Text-specific export options.
    txtOptions.Encoding = Encoding.Unicode
    txtOptions.Separator = CultureInfo.CurrentCulture.TextInfo.ListSeparator.ToString()

    ' Export the report to Text.
    report.ExportToText(reportPath)

    ' Show the result.
    StartProcess(reportPath)
End Sub

' Use this method if you want to automaically open
' the created Text 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 ExportToText(Stream, TextExportOptions) 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-webforms-print-export-report-without-showing-a-preview/CS/T227361/Default.aspx.cs#L89

case "txt":
    report.ExportToText(ms);
    break;

reporting-mvc-print-export-report-without-preview/CS/T569785/Controllers/HomeController.cs#L96

case "txt":
    report.ExportToText(ms);
    break;

VB.NET

reporting-webforms-print-export-report-without-showing-a-preview/VB/T227361/Default.aspx.vb#L78

Case "txt"
    report.ExportToText(ms)
Case "csv"

reporting-mvc-print-export-report-without-preview/VB/T569785/Controllers/HomeController.vb#L82

Case "txt"
    report.ExportToText(ms)
Case "csv"