TdxRichEditCustomDocumentServer.LoadDocumentTemplate(string) Method
Imports a document (as a template) from a file (in any supported format).
Declaration
procedure LoadDocumentTemplate(const AFileName: string); overload;Parameters
| Name | Type | Description |
|---|---|---|
| AFileName | string | An absolute or relative path to a source document file. |
Remarks
Call the LoadDocumentTemplate procedure to import a document from a file in any supported format. Imported content replaces the current document.
Related Properties and Events
The TdxRichEditDocumentServer component treats the imported document as a template (restores default values for Options.DocumentSaveOptions.CurrentFileName and Options.DocumentSaveOptions.CurrentFormat properties). A successful document import operation raises the OnDocumentLoaded event.
The OnDocumentClosing event occurs immediately before a document import operation if the current document contains unsaved changes.
Source Document Format Detection
The LoadDocumentTemplate procedure uses the source file name extension to identify the document format. If the specified file name has no extension, LoadDocumentTemplate iterates through all supported formats to find the best possible match for the source document.
Import Format Support
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.
Other Document 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).
- HtmlText
- Specifies document content as a string (in the HTML 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 | LoadDocumentTemplate | SaveDocument
- Export/import document content to/from a file or stream in any supported format.