PlainTextDocumentImporterOptions.Encoding Property

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

Namespace: DevExpress.XtraRichEdit.Import

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

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.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	A Encoding object providing the conversion between certain encoding and Unicode.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to Encoding
WinForms Controls	RichTextEditDocumentImportOptions	.PlainText .Encoding
Office File API	RichEditDocumentImportOptions	.PlainText .Encoding

Remarks

The PlainTextDocumentImporterOptions.AutoDetectEncoding property is set to true by default, the correct encoding is determined automatically and the document is loaded using the corresponding charset.

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)

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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#

import-from-html-how-to-specify-encoding-and-external-content-location-e1756/CS/BeforeImportExample/Form1.cs#L58

if(e.DocumentFormat == DocumentFormat.PlainText) {
    ((PlainTextDocumentImporterOptions)e.Options).Encoding = cur_Encoding;
}

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

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

VB.NET

import-from-html-how-to-specify-encoding-and-external-content-location-e1756/VB/BeforeImportExample/Form1.vb#L61

If e.DocumentFormat = DocumentFormat.PlainText Then
    CType(e.Options, PlainTextDocumentImporterOptions).Encoding = cur_Encoding
End If

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

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