BeforeImportEventArgs.DocumentFormat Property

Gets the format of the document being loaded.

Namespace: DevExpress.XtraRichEdit

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

Declaration

C#

public DocumentFormat DocumentFormat { get; }

VB.NET

Public ReadOnly Property DocumentFormat As DocumentFormat

Property Value

Type	Description
DocumentFormat	A DocumentFormat enumeration value.

Remarks

Note

When the RichEditControl.BeforeImport event of the SnapControl is handled, the DocumentFormat property has the SnapDocumentFormat.Snap value.

Related GitHub Examples

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

private void richEditControl1_BeforeImport(object sender, BeforeImportEventArgs e) {
    if(e.DocumentFormat == DocumentFormat.Html) {
        e.Options.SourceUri = "file:///" + Application.StartupPath + imgPath;

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

{
    if (e.DocumentFormat == DocumentFormat.PlainText)
    {

VB.NET

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

Private Sub richEditControl1_BeforeImport(ByVal sender As Object, ByVal e As BeforeImportEventArgs) Handles richEditControl1.BeforeImport
    If e.DocumentFormat = DocumentFormat.Html Then
        e.Options.SourceUri = "file:///" & Application.StartupPath & imgPath

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

Public Shared Sub BeforeImport(ByVal sender As Object, ByVal e As BeforeImportEventArgs)
    If e.DocumentFormat = DocumentFormat.PlainText Then
        CType(e.Options, PlainTextDocumentImporterOptions).Encoding = Encoding.GetEncoding(20866)