RichEditControl.BeforeExport Event

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

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.XtraRichEdit.v20.1.dll

Declaration

public event BeforeExportEventHandler BeforeExport
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

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

The BeforeExport event occurs after the RichEditControl.SaveDocument or RichEditControl.SaveDocumentAs method call.

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

The code sample below shows how specify export options for different formats in the RichEditControl.BeforeExport event handler.


private void RichEditControl_BeforeExport(object sender, BeforeExportEventArgs e)
{
    if (e.DocumentFormat == DocumentFormat.PlainText)
    {
        //Include document fields in the exported plain text:
        PlainTextDocumentExporterOptions plainTextOptions = e.Options as PlainTextDocumentExporterOptions;
        plainTextOptions.ExportHiddenText = true;
        plainTextOptions.FieldCodeEndMarker = ">";
        plainTextOptions.FieldCodeStartMarker = "[<";
        plainTextOptions.FieldResultEndMarker = "]";
    }

    if (e.DocumentFormat == DocumentFormat.OpenXml)
    {
        //Specify what DOCX document properties to export:
        OpenXmlDocumentExporterOptions docxOptions = e.Options as OpenXmlDocumentExporterOptions;
        docxOptions.ExportedDocumentProperties = DocumentPropertyNames.Title | DocumentPropertyNames.LastModifiedBy | DocumentPropertyNames.Modified;
    }

    if (e.DocumentFormat == DocumentFormat.Html)
    {
        //Specify HTML export options:
        HtmlDocumentExporterOptions htmlOptions = e.Options as HtmlDocumentExporterOptions;
        htmlOptions.EmbedImages = true;
        htmlOptions.CssPropertiesExportType = CssPropertiesExportType.Style;
        htmlOptions.UseFontSubstitution = false;
    }
}

Implements

See Also