TCustomRichView.LoadMarkdownFromStream

<< Click to display table of contents >>

TCustomRichView.LoadMarkdownFromStream

Appends the content of Markdown stream Stream to the document.

function LoadMarkdownFromStream(Stream: TStream;
  const Path: TRVUnicodeString

  CodePage: TRVCodePage = CP_UTF8): Boolean;

(Introduced in version 20)

Despite its name, this method does not clear the existing document before loading. To replace the current document with the content of this file, call Clear method before loading (and maybe DeleteUnusedStyles after Clear).

By default, the method assumes that the stream has UTF-8 encoding; but you can specify another CodePage in the parameter.

Path defines a base path for images. If rvmdloBasePathLinks is included MarkdownProperties.LoadOptions, this path is also used for hyperlinks.

Method type: viewerstyle viewer-style.

Parameters for loading are in MarkdownProperties. See the topic about the class of this property for the detailed explanation of Markdown import and export.

Unlike other loading methods, Markdown loading does not have an option to restrict formatting to existing text, paragraphs and list styles: it may add new styles.

By default, hyperlink targets are loaded in items tags. You can customize loading using OnReadHyperlink event.

Return value: "Was reading successful?"

 

See also methods of TRichView:

LoadMarkdown;

SaveMarkdown.

See also events of TRichView:

OnImportPicture;

OnReadHyperlink;

OnAssignImageFileName.

See also methods of TRichViewEdit:

InsertMarkdownFromStreamEd.

See also:

Saving and loading in TRichView.