RichEditControl.BeforeImport Event

Occurs before a document is loaded (imported from an external source).

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v23.2.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.RichEdit, DevExpress.Win.TreeMap

Declaration

C#

public event BeforeImportEventHandler BeforeImport

VB.NET

Public Event BeforeImport As BeforeImportEventHandler

Event Data

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

Property	Description
DocumentFormat	Gets the format of the document being loaded.
Options	Provides access to the importer options.

Remarks

The BeforeImport event enables you to adjust the importer options as required.

The following example illustrates how to use the BeforeImport event to specify the location of the loaded HTML file’s external content:

C#

private void richEditControl2_BeforeImport(object sender, BeforeImportEventArgs e) {
    if(e.DocumentFormat == DocumentFormat.PlainText) {
        ((PlainTextDocumentImporterOptions)e.Options).Encoding = cur_Encoding;
    }
}

VB.NET

Private Sub richEditControl2_BeforeImport(ByVal sender As Object, ByVal e As BeforeImportEventArgs) Handles richEditControl2.BeforeImport
    If e.DocumentFormat = DocumentFormat.PlainText Then
        CType(e.Options, PlainTextDocumentImporterOptions).Encoding = cur_Encoding
    End If
End Sub

Related GitHub Examples

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

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#

rich-text-editor-document-content-validator/CS/ContentAnalyzer/Form1.cs#L19

richEditControl.AddService(typeof(ILogUnsupportedContentService), new LogUnsupportedContentService(this.log));
richEditControl.BeforeImport += OnBeforeImport;
richEditControl.EmptyDocumentCreated += OnEmptyDocumentCreated;

VB.NET

rich-text-editor-document-content-validator/VB/ContentAnalyzer/Form1.vb#L21

richEditControl.AddService(GetType(ILogUnsupportedContentService), New LogUnsupportedContentService(Me.log))
AddHandler richEditControl.BeforeImport, AddressOf OnBeforeImport
AddHandler richEditControl.EmptyDocumentCreated, AddressOf OnEmptyDocumentCreated