XtraReport.ExportToText(String, TextExportOptions) Method

Exports a report to the specified file in text format.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.1.dll

Declaration

public void ExportToText(
    string path,
    TextExportOptions options = null
)
Public Sub ExportToText(
    path As String,
    options As TextExportOptions = Nothing
)

Parameters

Name Type Description
path String

A String that is the full path to a file.

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

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

Once the document export has started, it runs to completion and you cannot interrupt or cancel it.

This method exports a report to a text file with the specified text export options.

If the export options are not specified, the current report export options are used. To access the report export options, use the the report's XtraReport.ExportOptions property. The property contains the ExportOptions object whose ExportOptions.Text property provides access to the TextExportOptions object that contains the text export options.

IMPORTANT

This method overwrites files with the same name without confirmation.

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

Examples

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.

NOTE

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

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