rvico TRichView Reference | TRichView

TCustomRichView.AddHotspotEx, AddHotspotExTag

TCustomRichView.AddHotspot (deprecated)

Top  Previous  Next

These methods add hotspot (image from TImageList – hypertext link) to the end of document.

procedure AddHotspotExTag(const Name: TRVAnsiString;

  ImageIndex, HotImageIndex: Integer;

  ImageList: TCustomImageList; ParaNo: Integer;

  const Tag: TRVTag);

 

procedure AddHotspotEx(const Name: TRVAnsiString;

  ImageIndex, HotImageIndex: Integer;

  ImageList: TCustomImageList; ParaNo: Integer);

procedure AddHotspot(ImageIndex: Integer;

  ImageList: TCustomImageList; fromnewline: Boolean); deprecated;

AddHotspotEx provides a subset of functionality of AddHotspotExTag:

AddHotspotEx(...) is equivalent to AddHotspotExTag(..., '').

AddHotspot is deprecated and maintained for backward compatibility (with TRichView versions prior to 1.0):

AddHotspot(ImageIndex, ImageList, True) is equivalent to AddHotspotEx('', ImageIndex, ImageIndex, ImageList, 0).

AddHotspot(ImageIndex, ImageList, False) is equivalent to AddHotspotEx('', ImageIndex, ImageIndex, ImageList, -1).

 

Alternatives:

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

If you want to add a TGraphic picture-hyperlink, add a hot picture instead.

If you want to add a TGraphic picture, add a picture instead.

 

Parameters:

Name – name of hotspot, any string. Name must not contain CR and LF characters. RichView does not use Names itself, they are for your own use. This is an ANSI string, regardless of Unicode mode of text styles.

ImageIndex – index of image in ImageList.

HotImageIndex – index of "hot" image in ImageList. It is displayed when the mouse pointer is above this hotspot.

ImageList – image list for this hotspot. RichView does not own, does not copy and does not destroy imagelists, it just holds pointers to them. So this image list is not destroyed when the document is cleared.

If ParaNo=-1, the methods add the item to the end of the last paragraph. If ParaNo>=0, this item starts a new paragraph with the ParaNo-th style. (ParaNo is an index in the ParaStyles collection of the linked RVStyle component). It defines attributes for the new paragraph.

Tagtag of this hotspot.

 

Methods type: viewerstyle viewer-style.

unicode Unicode note: names of non-text items are ANSI strings.

See also methods:

Format;

FormatTail;

SetAddParagraphMode.

See also methods of TRichViewEdit:

InsertHotspot.

See also properties of TRVStyle:

ParaStyles.

See also:

Item types;

Other methods for appending items;

"Tags";

Hypertext in RichView.


TRichView © trichview.com