RtfDocumentExporterCompatibilityOptions.DuplicateObjectAsMetafile Property
Gets or sets whether inline objects are saved in the RTF file twice - as an object and as metafile content.
Namespace: DevExpress.XtraRichEdit.Export
Assembly: DevExpress.RichEdit.v19.1.Core.dll
Declaration
Property Value
| Type | Description |
|---|---|
| Boolean | true to duplicate objects as metafiles when saving; otherwise, false. Default value is false. |
Property Paths
You can access this nested property as listed below:
| Object Type | Path to DuplicateObjectAsMetafile |
|---|---|
| RtfDocumentExporterOptions |
|
Remarks
RTF specification allows RTF writers to save embedded pictures two times - in the native format and as a metafile, so if the application is unable to load the original object, it can skip it, and display the graphics metafile instead. Included metafiles may result in “bloated” RTF files.
By default, the pictures are saved only in original format. To enable dual saving of a picture (thus increasing the file size), you can handle the BeforeExport event and set the DuplicateObjectAsMetafile property to true. The following code snippet illustrates this technique.
Note
A complete sample project is available at https://github.com/DevExpress-Examples/how-to-save-a-document-in-the-richedit-control-e1401
using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.Export;
using DevExpress.XtraRichEdit.Services;
private void btnSaveToFile_Click(object sender, EventArgs e) {
richEditControl1.SaveDocument("SavedDocument.rtf", DocumentFormat.Rtf);
System.IO.FileInfo fi = new System.IO.FileInfo("SavedDocument.rtf");
string msg = String.Format("The size of the file is {0:#,#} bytes.", fi.Length.ToString("#,#"));
MessageBox.Show(msg);
}
private void richEditControl1_BeforeExport(object sender, DevExpress.XtraRichEdit.BeforeExportEventArgs e) {
DocumentExportCapabilities checkDocument = richEditControl1.Document.RequiredExportCapabilities;
if((e.DocumentFormat == DocumentFormat.Rtf) && checkDocument.InlinePictures ) {
DialogResult reduceFileSize = MessageBox.Show("This document contains inline pictures.\n" +
"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.\n" +
"Enable dual picture format in a saved file?",
"Warning", MessageBoxButtons.YesNo, MessageBoxIcon.Warning);
RtfDocumentExporterOptions options = e.Options as RtfDocumentExporterOptions;
if(options != null) {
switch (reduceFileSize) {
case DialogResult.Yes:
options.Compatibility.DuplicateObjectAsMetafile = true;
break;
case System.Windows.Forms.DialogResult.No:
options.Compatibility.DuplicateObjectAsMetafile = false;
break;
}
}
}
}
Related GitHub Examples
The following code snippets (auto-collected from DevExpress Examples) contain references to the DuplicateObjectAsMetafile 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.