IdxRichEditDocument.LoadDocument(TStream,TdxRichEditDocumentFormat,string) Method
Imports a document from a specified stream (in any supported format).
Declaration
procedure LoadDocument(AStream: TStream; AFormat: TdxRichEditDocumentFormat; const ASourceUri: string); overload;Parameters
| Name | Type | Description |
|---|---|---|
| AStream | TStream | The source stream. |
| AFormat | TdxRichEditDocumentFormat | The source document format. |
| ASourceUri | string | A path to external document content. |
Remarks
Call the LoadDocument procedure to import a document from a stream in any supported format. Imported content replaces the current document.
Related Properties
A successful LoadDocument call updates Options.DocumentSaveOptions.CurrentFileName and Options.DocumentSaveOptions.CurrentFormat property values for the parent TdxRichEditControl or TdxRichEditDocumentServer component.
Source Document Format Detection
Use the AFormat parameter to specify the source document format.
If you pass TdxRichEditDocumentFormat.Undefined as the AFormat parameter, the LoadDocument procedure iterates through all supported formats to identify the best possible match for the source document.
Import Format Support
DevExpress Rich Text components initially support 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.
To enable support for all available formats, add all required dependencies at design time or in code:
| Extension | Document Format | Format Value | Import/Export Settings | Support / Required Dependencies |
|---|---|---|---|---|
TXT/txt |
Plain Text | PlainText | Options.Import.PlainText/Options.Export.PlainText | Built-in Support |
RTF/rtf |
Rich Text Format | Rtf | Options.Import.Rtf/Options.Export.Rtf | dxRichEdit.Rtf (add only for TdxRichEditDocumentServer) |
DOC/doc |
Microsoft Word® 97 – 2003 | Doc | Options.Import.Doc/Options.Export.Doc | dxRichEdit.Doc |
HTML/html |
Hypertext Markup Language | Html | Options.Import.Html/Options.Export.Html | dxRichEdit.Html |
DOCX/docx |
Office OpenXML | OpenXml | Options.Import.OpenXml/Options.Export.OpenXml | dxRichEdit.OpenXML |
At design time, you can right-click a TdxRichEditControl or TdxRichEditDocumentServer component, expand the Add Unit to Support menu item, and add all required dependencies.
Other Import/Export Options
You can also use the following API members to import/export document content in different supported[1] formats:
- DocBytes
- Specifies document content as a byte array (in the Microsoft Word® 97 – 2003 binary format).
- OpenXmlBytes
- Specifies document content as a byte array (in the Office OpenXML format).
- RtfText
- Specifies document content (as an RTF string).
- Text
- Specifies document content (as a plain text string).
- LoadDocument | SaveDocument
- Export/import document content to/from file or stream in any supported format.