BeforeExportEventArgs.DocumentFormat Property

Gets the format of the document being exported or saved.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v19.1.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.BeforeExport event of the SnapControl is handled, the DocumentFormat property has the SnapDocumentFormat.Snap value.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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#

how-to-save-a-document-in-the-richedit-control-e1401/CS/SaveDocument/Form1.cs#L41

DocumentExportCapabilities checkDocument = richEditControl1.Document.RequiredExportCapabilities;
if((e.DocumentFormat == DocumentFormat.Rtf) && checkDocument.InlinePictures ) {
    DialogResult reduceFileSize = MessageBox.Show("This document contains inline pictures.\n" +

VB.NET

how-to-save-a-document-in-the-richedit-control-e1401/VB/SaveDocument/Form1.vb#L40

Dim checkDocument As DocumentExportCapabilities = richEditControl1.Document.RequiredExportCapabilities
If (e.DocumentFormat = DocumentFormat.Rtf) AndAlso checkDocument.InlinePictures Then
    Dim reduceFileSize As DialogResult = MessageBox.Show("This document contains inline pictures." & Constants.vbLf & "You can embed the same picture in two different types (original and Windows Metafile) for better compatibility" & " although it increases the file size. By default a picture is saved in original format only." & Constants.vbLf & "Enable dual picture format in a saved file?", "Warning", MessageBoxButtons.YesNo, MessageBoxIcon.Warning)