SpreadsheetControl.BeforeEncodingDetection Event

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

Namespace: DevExpress.XtraSpreadsheet

Assembly: DevExpress.XtraSpreadsheet.v24.1.dll

NuGet Package: DevExpress.Win.Spreadsheet

Declaration

C#

public event EventHandler<BeforeEncodingDetectionEventArgs> BeforeEncodingDetection

VB.NET

Public Event BeforeEncodingDetection As EventHandler(Of BeforeEncodingDetectionEventArgs)

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.

C#

using DevExpress.Office;

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

VB.NET

Imports DevExpress.Office

Private Sub SpreadsheetControl_BeforeEncodingDetection(ByVal sender As Object, ByVal e As BeforeEncodingDetectionEventArgs)
  e.Encoding = Encoding.UTF8
  e.Handled = True
End Sub