Document.RequiredExportCapabilities Property

Obtains information on the formatting capabilities required to export the current document correctly.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

DocumentExportCapabilities RequiredExportCapabilities { get; }

VB.NET

ReadOnly Property RequiredExportCapabilities As DocumentExportCapabilities

Property Value

Type	Description
DocumentExportCapabilities	A DocumentExportCapabilities object, representing information on the formatting capabilities required to correctly format the current document.

Remarks

In order to check whether the document can be correctly exported to various formats, you can get the information about formatting features applied to the document. The RequiredExportCapabilities property provides access to a structure which indicates if non-default character formatting, paragraph formatting, inline pictures or objects etc. are contained within the document. Use its properties, such as the DocumentExportCapabilities.ParagraphFormatting, DocumentExportCapabilities.Sections and others, or the DocumentExportCapabilities.Contains method to compare the export method capabilities with the document features which should be supported, to ensure the correct result.

The following code snippet illustrates how you can detect if the capabilities of your custom exporter match the formatting capabilities required to export the current document. First, declare the exporter capabilities in the DocumentExportCapabilities structure, and then compare it with the structure obtained via the Document.RequiredExportCapabilities property.

C#

DevExpress.XtraRichEdit.DocumentExportCapabilities myExportFeatures = 
    new DevExpress.XtraRichEdit.DocumentExportCapabilities();
myExportFeatures.CharacterFormatting = true;
myExportFeatures.ParagraphFormatting = true;
myExportFeatures.InlinePictures= true;

if(myExportFeatures.Contains(richEditControl1.Document.RequiredExportCapabilities))
    MessageBox.Show("The document can be exported");

VB.NET

Dim myExportFeatures As DevExpress.XtraRichEdit.DocumentExportCapabilities = 
New DevExpress.XtraRichEdit.DocumentExportCapabilities()
myExportFeatures.CharacterFormatting = True
myExportFeatures.ParagraphFormatting = True
myExportFeatures.InlinePictures= True

If myExportFeatures.Contains(richEditControl1.Document.RequiredExportCapabilities) Then
    MessageBox.Show("The document can be exported")
End If

Related GitHub Examples

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

private void richEditControl1_BeforeExport(object sender, DevExpress.XtraRichEdit.BeforeExportEventArgs e) {
    DocumentExportCapabilities checkDocument = richEditControl1.Document.RequiredExportCapabilities;
    if((e.DocumentFormat == DocumentFormat.Rtf) && checkDocument.InlinePictures ) {

VB.NET

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

Private Sub richEditControl1_BeforeExport(ByVal sender As Object, ByVal e As DevExpress.XtraRichEdit.BeforeExportEventArgs) Handles richEditControl1.BeforeExport
    Dim checkDocument As DocumentExportCapabilities = richEditControl1.Document.RequiredExportCapabilities
    If (e.DocumentFormat = DocumentFormat.Rtf) AndAlso checkDocument.InlinePictures Then