PlainTextDocumentImporterOptions.Encoding Property

Gets or sets the encoding used to interpret characters in the document.

Namespace: DevExpress.XtraRichEdit.Import

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

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

[TypeConverter(typeof(EncodingConverter))]
public Encoding Encoding { get; set; }

VB.NET

<TypeConverter(GetType(EncodingConverter))>
Public Property Encoding As Encoding

Property Value

Type	Description
Encoding	An object that contains character encoding parameters.

Property Paths

You can access this nested property as listed below:

Object Type	Path to Encoding
RichEditDocumentImportOptions	.PlainText .Encoding

Remarks

Set the PlainTextDocumentImporterOptions.AutoDetectEncoding property to false to disable automatic encoding, and then specify the Encoding property as shown below:

C#

RichEditDocumentServer wordProcessor = new RichEditDocumentServer();

PlainTextDocumentImporterOptions plainTextImporterOptions = wordProcessor.Options.Import.PlainText;
plainTextImporterOptions.AutoDetectEncoding = false;
plainTextImporterOptions.Encoding = Encoding.Unicode;

wordProcessor.LoadDocument("Documents//Doc1.txt", DocumentFormat.PlainText);

VB.NET

Dim wordProcessor As New RichEditDocumentServer()

Dim plainTextImporterOptions As PlainTextDocumentImporterOptions = wordProcessor.Options.Import.PlainText
plainTextImporterOptions.AutoDetectEncoding = False
plainTextImporterOptions.Encoding = Encoding.Unicode

wordProcessor.LoadDocument("Documents//Doc1.txt", DocumentFormat.PlainText)

Tip

Handle the BeforeEncodingDetection event to specify a custom encoding instead of the automatically detected encoding. The event is raised only if the PlainTextDocumentImporterOptions.AutoDetectEncoding property is set to true.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Encoding property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

word-document-api-examples/CS/CodeExamples/ImportActions.cs#L43

{
    ((PlainTextDocumentImporterOptions)e.Options).Encoding = Encoding.GetEncoding(20866);
}

VB.NET

word-document-api-examples/VB/CodeExamples/ImportActions.vb#L40

If e.DocumentFormat = DevExpress.XtraRichEdit.DocumentFormat.PlainText Then
    CType(e.Options, DevExpress.XtraRichEdit.Import.PlainTextDocumentImporterOptions).Encoding = System.Text.Encoding.GetEncoding(20866)
End If