TdxRichEditControlBase.SaveDocument(TStream,TdxRichEditDocumentFormat) Method
Exports document content to a stream (in any supported format).
Declaration
procedure SaveDocument(AStream: TStream; ADocumentFormat: TdxRichEditDocumentFormat); overload;Parameters
| Name | Type | Description |
|---|---|---|
| AStream | TStream | The target stream. |
| ADocumentFormat | TdxRichEditDocumentFormat | The target document format. |
Remarks
Call the SaveDocument procedure to export the current document to a stream in any supported format.
Note
Unlike other overloaded SaveDocument procedures, the current SaveDocument implementation does not reset the DocumentModelModified property to False.
Available Export Formats
The SaveDocument procedure accepts the required export format as the ADocumentFormat parameter. If you pass TdxRichEditDocumentFormat.Undefined as the parameter, the Options.DocumentSaveOptions.DefaultFormat or Options.DocumentSaveOptions.CurrentFormat property defines the target document format for a new or existing file, respectively.
Export Format Support
Support for all document formats, except for TXT and RTF, is initially disabled for the TdxRichEditControl 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 | Built-in Support |
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 TdxRichEditControl component, expand the Add Unit to Support menu item, and add all required dependencies.
Related End-User Commands
The TdxRichEditControl component ships with the following action classes you can use to add Save and Save As end-user commands in your application:
- TdxRichEditControlSaveDocument
- A SaveDocument command’s action object.
- TdxRichEditControlSaveDocumentAs
- A SaveDocumentAs command action object.
Tip
You can use automatic UI generation to create a Ribbon or toolbar UI populated with all predefined end-user commands available for TdxRichEditControl as demonstrated in the following topic:
How to Create a Ribbon or Toolbar UI for your Rich Edit-based Application
Other Document Import/Export Options
You can also use the following API members to import/export document content in different supported[1] formats:
- LoadDocument
- Imports document content from a file or stream (in any supported format).
- LoadDocumentTemplate
- Imports a document as a template from a file or stream (in any supported format).
- SaveDocument
- Exports document content to a file or stream (in any supported format).