Back to Devexpress

GridControl.ExportToText(Stream, String, Boolean, Encoding) Method

windowsforms-devexpress-dot-xtragrid-dot-gridcontrol-dot-exporttotext-x28-system-dot-io-dot-stream-system-dot-string-system-dot-boolean-system-dot-text-dot-encoding-x29.md

latest3.7 KB
Original Source

GridControl.ExportToText(Stream, String, Boolean, Encoding) Method

OBSOLETE

Use the ExportToText method instead

Exports the data displayed by the GridControl.DefaultView (the GridControl.MainView or the currently maximized detail View) to a stream in TXT format using the specified separator string, quotation and text encoding settings.

Namespace : DevExpress.XtraGrid

Assembly : DevExpress.XtraGrid.v25.2.dll

NuGet Packages : DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

csharp
[EditorBrowsable(EditorBrowsableState.Never)]
[Obsolete("Use the ExportToText(Stream stream, TextExportOptions options) method instead")]
public void ExportToText(
    Stream stream,
    string separator,
    bool quoteStringsWithSeparators,
    Encoding encoding
)
vb
<Obsolete("Use the ExportToText(Stream stream, TextExportOptions options) method instead")>
<EditorBrowsable(EditorBrowsableState.Never)>
Public Sub ExportToText(
    stream As Stream,
    separator As String,
    quoteStringsWithSeparators As Boolean,
    encoding As Encoding
)

Parameters

NameTypeDescription
streamStream

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

| | separator | String |

A String containing symbols which will be used to separate the document’s text elements in the created text file.

| | quoteStringsWithSeparators | Boolean |

true to quote (place quotation marks around) separator string text elements; otherwise, false.

| | encoding | Encoding |

A Encoding class descendant specifying the encoding of the created text document.

|

Remarks

This method indirectly calls the PrintingSystemBase.ExportToText method of the XtraPrinting Library. If this library is not available the method does nothing. For details on the ExportToText method see the PrintingSystemBase.ExportToText topic.

For general information on exporting data in the Grid Control refer to Export Overview.

See Also

ExportToText

Export Overview

GridControl Class

GridControl Members

DevExpress.XtraGrid Namespace