The requested page is not available for the requested platform. You are viewing the content for Default platform.

XtraReport.ExportToText(String) Method

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

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v19.1.dll

Declaration

public void ExportToText(
    string path
)
Public Sub ExportToText(
    path As String
)

Parameters

Name Type Description
path String

A String which specifies the file name (including the full path) for the created Text 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 a Text file using its current Text-specific export options. These options are represented by the TextExportOptions object returned by the ExportOptions.Text property of a report's XtraReport.ExportOptions. This object provides the TextExportOptionsBase.Encoding, TextExportOptionsBase.Separator and other properties which are intended to specify parameters of the resulting Text file.

If you want to ignore current export options of a report, and use your specific settings when a report is exported to Text, you should use the overloaded XtraReport.ExportToText method with the options parameter.

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 ExportToText method, and limitations on export to Text, please refer to the Export to Text document.

Examples

The following example demonstrates how to export a report to Text format. To do this, the XtraReport.ExportToText method should be used. It also demonstrates what specific TextExportOptions may be used when a report is exported to Text.

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 *.txt files in your system, you can call the StartProcess method, which is also shown in this example.

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