Skip to main content
All docs
V24.1
Row

Workbook.BeforeEncodingDetection Event

Occurs before detecting the encoding of the loaded CSV or TXT data.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Docs.v24.1.dll

NuGet Package: DevExpress.Document.Processor

Declaration

public event EventHandler<BeforeEncodingDetectionEventArgs> BeforeEncodingDetection

Event Data

The BeforeEncodingDetection event's data class is BeforeEncodingDetectionEventArgs. The following properties provide information specific to this event:

Property Description
Encoding Gets or sets the document encoding.
Handled Gets or sets whether the event is handled.
Stream Obtains a stream with document data.

Remarks

The BeforeEncodingDetection event is raised when the spreadsheet attempts to detect encoding of the CSV or TXT text being imported. Handle this event to specify a custom encoding instead of the automatically detected encoding.

The event fires only if the TxtDocumentImporterOptions.AutoDetectEncoding or CsvDocumentImporterOptions.AutoDetectEncoding property is set to true.

The code sample below shows how to handle the event to specify the encoding:

private void Workbook_BeforeEncodingDetection(object? sender, BeforeEncodingDetectionEventArgs e)
{
    e.Encoding = Encoding.UTF8;
    e.Handled = true;
}
See Also