vcl-dxrichedit-dot-documentserver-dot-tdxricheditcustomdocumentserver-dot-loaddocument-x28-system-dot-classes-dot-tstream-dxrichedit-dot-nativeapi-dot-tdxricheditdocumentformat-x29.md
Imports a document from a stream (in any supported format).
function LoadDocument(AStream: TStream; ADocumentFormat: TdxRichEditDocumentFormat): Boolean; overload;
| Name | Type | Description |
|---|---|---|
| AStream | TStream |
The source stream.
| | ADocumentFormat | TdxRichEditDocumentFormat |
The source document format.
|
| Type | Description |
|---|---|
| Boolean |
True if the source document is loaded successfully; otherwise, False.
|
Call the LoadDocument function to import a document from a stream in any supported format. Imported content replaces the current document.
A successful LoadDocument call updates Options.DocumentSaveOptions.CurrentFileName and Options.DocumentSaveOptions.CurrentFormat property values and raises the OnDocumentLoaded event.
The OnDocumentClosing event occurs immediately before a document import operation if the current document contains unsaved changes.
Use the DocumentFormat parameter to specify the source document format.
If you pass TdxRichEditDocumentFormat.Undefined as the DocumentFormat parameter, the LoadDocument procedure iterates through all supported formats to identify the best possible match for the source document.
Support for all document formats, except for plain text, is initially disabled for the TdxRichEditDocumentServer component to avoid excessive dependencies. To enable support for 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 |
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 the TdxRichEditDocumentServer component, expand the Add Unit to Support menu item, and add all required dependencies.
You can also use the following API members to import/export document content in different supported[1] formats:
DocBytesSpecifies document content as a byte array (in the Microsoft Word® 97 – 2003 binary format).HtmlTextSpecifies document content as a string (in the HTML format).OpenXmlBytesSpecifies document content as a byte array (in the Office OpenXML format).RtfTextSpecifies document content (as an RTF string).TextSpecifies document content (as a plain text string).LoadDocument | LoadDocumentTemplate | SaveDocumentExport/import document content to/from a file or stream in any supported format.
Footnotes
See Also
IdxRichEditDocument.LoadDocument Method
TdxRichEditControlBase.LoadDocument Method
Document Print and Import/Export
TdxRichEditCustomDocumentServer Class