RichEditControl.BeforeExport Event

Occurs before the document is saved (exported to a certain format).

Namespace: DevExpress.Xpf.RichEdit

Assembly: DevExpress.Xpf.RichEdit.v20.2.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.RichEdit, DevExpress.Wpf.RichEdit

Declaration

C#

public event BeforeExportEventHandler BeforeExport

VB.NET

Public Event BeforeExport As BeforeExportEventHandler

Event Data

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

Property	Description
CustomProperties	Provides access to the document’s custom properties.
DocumentFormat	Gets the format of the document being exported or saved.
Options	Provides access to the exporter options.

Remarks

You can check the Document.RequiredExportCapabilities to be sure that the chosen export format supports them.

The BeforeExport event enables you to adjust the export options as required.

For RTF format, you can specify the RtfDocumentExporterCompatibilityOptions.DuplicateObjectAsMetafile property. For the HTML format, set the location of external content (images, css files) via the IExporterOptions.TargetUri property and specify other HtmlDocumentExporterOptions.

Related GitHub Examples

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

XAML

dxrichedit-for-wpf-how-to-save-the-text-of-a-document-range-in-different-formats/CS/MainWindow.xaml#L250

    </StackPanel>
    <dxre:RichEditControl Name="richEditControl1" BarManager="{Binding ElementName=barManager1, Mode=OneTime}" Ribbon="{Binding ElementName=ribbonControl1, Mode=OneTime}" Grid.Row="1" BeforeExport="richEditControl1_BeforeExport" />
</Grid>

C#

dxrichedit-for-wpf-building-a-mail-application-with-the-richeditcontrol-e3276/CS/MainWindow.xaml.cs#L76

protected internal virtual AlternateView CreateHtmlView() {
    control.BeforeExport += OnBeforeExport;
    string htmlBody = control.Document.GetHtmlText(control.Document.Range, this);

VB.NET

dxrichedit-for-wpf-building-a-mail-application-with-the-richeditcontrol-e3276/VB/MainWindow.xaml.vb#L78

Protected Friend Overridable Function CreateHtmlView() As AlternateView
    AddHandler control.BeforeExport, AddressOf OnBeforeExport
    Dim htmlBody As String = control.Document.GetHtmlText(control.Document.Range, Me)