A newer version of this page is available. Switch to the current version.

PrintingSystemBase.ExportToText(Stream, TextExportOptions) Method

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

Namespace: DevExpress.XtraPrinting

Assembly: DevExpress.Printing.v18.2.Core.dll

Declaration

public virtual void ExportToText(
    Stream stream,
    TextExportOptions options
)
Public Overridable Sub ExportToText(
    stream As Stream,
    options As TextExportOptions
)

Parameters

Name Type Description
stream Stream

A Stream object to which the created Text file should be sent.

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 in Text format 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 you want to use the current export options of a printing system, you should call the overloaded PrintingSystemBase.ExportToText method without the options parameter.

For more information, see Export to Text.

See Also