TCustomRichView.SaveHTML

<< Click to display table of contents >>

TCustomRichView.SaveHTML

Exports TRichView document to HTML (or XHTML) file

function SaveHTML(const FileName: TRVUnicodeString;
  Part: TRVHTMLSavingPart = rvhtmlspComplete): Boolean;
  overload;

(introduced in version 21)

This method saves HTML file and optionally a set of images (in separate files).

Parameters:

FileName the name of the output HTML file.

Part the part of HTML to save. By default, the whole HTML is saved.

 

The following properties are used:

HTMLSaveProperties

DocParameters.Title, Author, and Comments.

 

By default, inserted controls are not saved. You can save them yourself using OnSaveComponentToFile event.

By default, items tags are saved as targets of hypertext links. You can customize saving using OnWriteHyperlink event.

You can save additional information about non-text objects in OnWriteObjectProperties event.

You can:

completely change HTML code for certain items using OnSaveItemToFile event;

insert additional code in HTML in OnSaveHTMLExtra and OnSaveParaToHTML events;

change how images are saved using OnHTMLSaveImage or OnSaveImage2 event,

insert HTML codes in text.

 

Return value: "successful saving?"

 

See also methods:

SaveHTMLToStream

See also events:

OnWriteHyperlink;

OnWriteObjectProperties;

OnSaveComponentToFile;

OnSaveHTMLExtra;

OnHTMLSaveImage;

OnSaveImage2;

OnSaveItemToFile;

OnSaveParaToHTML;

OnProgress.

See also:

Export to HTML;

RichViewSavePInHTML typed constant;

TFontInfo.Options (HTML codes);

Saving and loading.