.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
.NET Core 3.0+

PlainTextDocumentExporterOptions Class

Contains options used for saving (exporting) the plain text document.

Namespace: DevExpress.XtraRichEdit.Export

Assembly: DevExpress.RichEdit.v19.2.Core.dll

Declaration

[ComVisible(true)]
public class PlainTextDocumentExporterOptions :
    DocumentExporterOptions
<ComVisible(True)>
Public Class PlainTextDocumentExporterOptions
    Inherits DocumentExporterOptions
[ComVisible(true)]
public class PlainTextDocumentExporterOptions :
    DocumentExporterOptions
<ComVisible(True)>
Public Class PlainTextDocumentExporterOptions
    Inherits DocumentExporterOptions
[ComVisible(true)]
public class PlainTextDocumentExporterOptions :
    DocumentExporterOptions
<ComVisible(True)>
Public Class PlainTextDocumentExporterOptions
    Inherits DocumentExporterOptions

Remarks

An instance of the PlainTextDocumentExporterOptions class is accessible via the RichEditDocumentExportOptions.PlainText property. You can use the following notation:


RichEditControl.Options.Export.PlainText

An instance of the PlainTextDocumentExporterOptions class is also used to specify export settings in the SubDocument.GetText method.

Examples

Note

A complete sample project is available at Exploring plain text exporter options.

The following code snippet illustrates how to use the PlainTextDocumentExporterOptions object properties to achieve the following:

  • Include document fields in the exported text
  • Enclose fields and their results in the specified symbols
  • Set character encoding
richEditControl1.Options.Export.PlainText.ExportHiddenText = true;
richEditControl1.Options.Export.PlainText.FieldCodeStartMarker = "[<";
richEditControl1.Options.Export.PlainText.FieldCodeEndMarker = ">";
richEditControl1.Options.Export.PlainText.FieldResultEndMarker = "]";
richEditControl1.Options.Export.PlainText.Encoding = Encoding.GetEncoding("Windows-1252");

Implements

See Also