rvico TRichView Reference | TRichView

TCustomRichView.AddHotPicture

Top  Previous  Next

Adds picture-hyperlink to the end of document.

procedure AddHotPicture(const Name: TRVUnicodeString; gr: TGraphic;

  ParaNo: Integer = -1; VAlign: TRVVAlign = rvvaBaseline; 

  const Tag: TRVTag = RVEMPTYTAG);

(introduced in version 1.5; changed in version 18)

The same as AddPicture, but this picture will be a hypertext link.

Parameters:

Name – name of this hot-picture item, any string. Name must not contain CR and LF characters. TRichView does not use Names itself, they are for your own use.

gr – picture to insert. By default, this picture will be owned by TRichView control, and you must not free it. However, you can specify nonzero rvepShared extra item property, and this graphic object will be shared (you need to free it yourself after TRichView is cleared).

Rarely used images may be "deactivated", i.e. stored in a memory stream and destroyed (see RichViewMaxPictureCount). Shared images are never deactivated.

VAlign – vertical align of this picture, relative to its line, see TRVVAlign for possible values.

If ParaNo=-1, the method adds an item to the end of the last paragraph. If ParaNo>=0, this item starts a new paragraph using attributes defined in Style.ParaStyles[ParaNo].

Tagtag of this hot-picture item..

Alternatives:

If you want to add a simple (not a hyperlink) TGraphic picture, add a picture instead.

If you want to add a hyperlink-picture from image list, add a hotspot instead.

If you want to add a simple (not a hyperlink) picture from image list, add a bullet instead.

Methods type: viewerstyle viewer-style.

See also methods:

Format;

FormatTail;

SetAddParagraphMode.

See also methods of TRichViewEdit:

InsertHotPicture.

See also properties of TRVStyle:

ParaStyles.

See also:

Item types;

Other methods for appending items;

"Tags";

Hypertext in TRichView.


Related deprecated methods:

procedure AddHotPictureTag(const Name: TRVUnicodeString;

  gr: TGraphic; ParaNo: Integer;

  VAlign: TRVVAlignconst Tag: TRVTag);.


TRichView © trichview.com