Back to Devexpress

TdxRichEditCustomDocumentServer.SaveDocument(TStream,TdxRichEditDocumentFormat) Method

vcl-dxrichedit-dot-documentserver-dot-tdxricheditcustomdocumentserver-dot-savedocument-x28-system-dot-classes-dot-tstream-dxrichedit-dot-nativeapi-dot-tdxricheditdocumentformat-x29.md

latest5.7 KB
Original Source

TdxRichEditCustomDocumentServer.SaveDocument(TStream,TdxRichEditDocumentFormat) Method

Exports document content to a stream (in any supported format).

Declaration

delphi
procedure SaveDocument(AStream: TStream; ADocumentFormat: TdxRichEditDocumentFormat); overload;

Parameters

NameTypeDescription
AStreamTStream

A target stream.

| | ADocumentFormat | TdxRichEditDocumentFormat |

A document format.

|

Remarks

Call the SaveDocument procedure to export the current document to a stream in any supported format.

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 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:

ExtensionDocument FormatFormat ValueImport/Export SettingsSupport / Required Dependencies
TXT/txtPlain TextPlainTextOptions.Import.PlainText/Options.Export.PlainTextBuilt-in Support
RTF/rtfRich Text FormatRtfOptions.Import.Rtf/Options.Export.RtfdxRichEdit.Rtf
DOC/docMicrosoft Word® 97 – 2003DocOptions.Import.Doc/Options.Export.DocdxRichEdit.Doc
HTML/htmlHypertext Markup LanguageHtmlOptions.Import.Html/Options.Export.HtmldxRichEdit.Html
DOCX/docxOffice OpenXMLOpenXmlOptions.Import.OpenXml/Options.Export.OpenXmldxRichEdit.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:

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

  1. Ensure that support for all required document formats is enabled; otherwise, an exception occurs.
    Refer to corresponding API member descriptions for detailed information on support for different document formats.

See Also

IdxRichEditDocument.SaveDocument Method

TdxRichEditControlBase.SaveDocument Method

Document Print and Import/Export

TdxRichEditCustomDocumentServer Class

TdxRichEditCustomDocumentServer Members

dxRichEdit.DocumentServer Unit