Skip to main content

TdxRichEditDocumentFormat Enum

Enumerates document formats available for TdxRichEditControl and TdxRichEditDocumentServer components.

Declaration

TdxRichEditDocumentFormat = (
    Undefined,
    PlainText,
    Rtf,
    Html,
    OpenXml,
    Doc
);

Members

Name Description Import/Export Settings Support / Required Dependencies
Undefined

The document format is undefined.

Document import routines iterate through all supported formats to find the best possible match.

Document export routines use the Options.DocumentSaveOptions.DefaultFormat or Options.DocumentSaveOptions.CurrentFormat property to determine the target document format for a new or existing file, respectively.

N/A

N/A

PlainText

The plain text format (TXT).

Options.Export.PlainText/Options.Import.PlainText

Built-in Support

Rtf

The Rich Text format (RTF).

Options.Export.Rtf/Options.Import.Rtf

dxRichEdit.Rtf (add only for TdxRichEditDocumentServer)

Html

The HyperText Markup Language (HTML) format.

DevExpress Rich Text components have no web browser or HTML editor functionality because they do not work with HTML tags directly. HTML import routines interpret tags in a source document and build an internal document model according to the current import settings.

Important

HTML import and export routines support only a limited subset of the modern HTML standard; therefore, imported and exported documents may look different compared to corresponding source documents.

Options.Export.Html/Options.Import.Html

dxRichEdit.Html

OpenXml

The Office OpenXML file format (DOCX/DOTX, the default Microsoft Word® 2007 document format).

DevExpress Rich Text components support document encryption for this format. A document export operation enforces password protection after a Document.SetEncryptionPassword procedure call.

Options.Export.OpenXml/Options.Import.OpenXml

dxRichEdit.OpenXML

Doc

The document binary file format (DOC, the Microsoft Word® format, used as the default document format in Microsoft Office® 2003 and earlier versions).

Options.Export.Doc/Options.Import.Doc

dxRichEdit.Doc

Remarks

TdxRichEditControl and TdxRichEditDocumentServer components allow you to import/export documents to/from a file or stream in a format of your choice: RTF, TXT, DOCX, HTML, and DOC.

Note

TdxRichEditDocumentFormat is a scoped enumeration type. Use the type name together with a scope resolution token (. in Delphi or :: in C++Builder) followed by an enumeration value to refer to this value. For example, use TdxRichEditDocumentFormat.Rtf (in Delphi) or TdxRichEditDocumentFormat::Rtf (in C++Builder) to refer to the Rtf value in code.

Support for Individual Document Formats

DevExpress Rich Text components initially support only a limited number of document formats to avoid excessive dependencies:

TdxRichEditControl
Has predefined support only for TXT and RTF.
TdxRichEditDocumentServer
Has predefined support only for TXT.

Tip

Refer to the following help topic for detailed information on document format support and import/export APIs:

Document Import and Export

Direct TdxRichEditDocumentFormat Type References

The following public properties reference the TdxRichEditDocumentFormat type:

TdxDocumentSaveOptions.CurrentFormat
Specifies the current document export format.
TdxDocumentSaveOptions.DefaultFormat
Specifies the default format for document export operations.
See Also