TdxRichEditCustomDocumentServer.LoadDocument(string) Method

Imports a document from a file (in any supported format).

Declaration

procedure LoadDocument(const AFileName: string); overload;

Parameters

Name	Type	Description
AFileName	string	An absolute or relative path to a source document file.

Remarks

Call the LoadDocument procedure to import a document from a file in any supported format. Imported content replaces the current document.

Related Properties and Events

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.

Source Document Format Detection

The LoadDocument procedure uses the source file name extension to identify the target format. If the file name has no extension, LoadDocument 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.

Code Example: Use UTF-7 to Import HTML Documents

The following code example defines the UTF-7 encoding to load an HTML document:

Delphi

uses
  dxRichEdit.DocumentServer,  // Declares the TdxRichEditDocumentServer component
  dxRichEdit.Html;  // Declares HTML format implementation

// ...

var
  ADocumentServer: TdxRichEditDocumentServer;
begin
  ADocumentServer := TdxRichEditDocumentServer.Create(nil);
  try
    ADocumentServer.Options.Import.Html.AutoDetectEncoding := False;
    ADocumentServer.Options.Import.Html.Encoding := CP_UTF7;
    ADocumentServer.LoadDocument('Document1.html');
    // Your document processing code
  finally
    ADocumentServer.Free;
  end;
end;

C++

#include "dxRichEdit.DocumentServer.hpp"  // Declares the TdxRichEditDocumentServer component
#include "dxRichEdit.Html"  // Declares HTML format implementation

// Add the following linker directives to the corresponding CPP source file:
#pragma link "dxRichEdit.DocumentServer"  // Required to use dxRichEdit.DocumentServer.hpp declarations
#pragma link "dxRichEdit.Html"  // Declares HTML format implementation

  TdxRichEditDocumentServer *ADocumentServer;
  try
  {
    ADocumentServer = new TdxRichEditDocumentServer(nullptr);
    ADocumentServer->Options->Import->Html->AutoDetectEncoding = false;
    ADocumentServer->Options->Import->Html->Encoding = CP_UTF7;
    ADocumentServer->LoadDocument("Document1.html");
    // Your document processing code
  }
  __finally
  {
    delete ADocumentServer;
  }

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.

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.