PrintingSystemBase.ExportToText(String, TextExportOptions) Method

Exports a document to the specified file path in Text format using the defined Text-specific options.

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v24.1.Core.dll

NuGet Package: DevExpress.Printing.Core

Declaration

C#

public void ExportToText(
    string filePath,
    TextExportOptions options
)

VB.NET

Public Sub ExportToText(
    filePath As String,
    options As TextExportOptions
)

Parameters

Name	Type	Description
filePath	String	A String which specifies the file name (including the full path) for the created Text file.
options	TextExportOptions	A TextExportOptions object which specifies the Text export options to be applied when a document is exported.

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 document to a Text file using the specified Text export options (e.g. TextExportOptionsBase.Encoding, TextExportOptionsBase.Separator and so on).

Note that in this instance the current printing system’s export options, which are represented by the TextExportOptions object returned by the ExportOptions.Text property of a printing system’s PrintingSystemBase.ExportOptions, are ignored.

If, instead, you want to use the current export options of a printing system, you should call the overloaded PrintingSystemBase.ExportToText method without the options parameter.

Note

This method overwrites any files present at the specified path that have the same file name without any warnings.

For more information, see Export to Text.