TCustomRichView.GetJumpPointItemNo (deprecated)

<< Click to display table of contents >>

TCustomRichView.GetJumpPointItemNo (deprecated)

Returns index of hypertext item (hotspot, hot-picture or text hypertext) by its hypertext id.

function GetJumpPointItemNo(id: Integer): Integer;

Warning: do not use this function for document containing tables. When the link is in table cell, or in cell inplace-editor, it can not be addressed using only an index of item. Use GetJumpPointLocation instead.


id identifier of the hypertext link; links are numbered sequentially starting from FirstJumpNo.

Return value

Index of the hypertext item (in range 0..ItemCount-1). If there is no link with such id, the method returns -1.


Note: this function contains some calculations inside (iterations through hyperlinks, from the first link to the requested one)


For TCustomRichViewEdit, if ReadOnly=False, this function always returns -1 (except for calling it from inside OnWriteHyperlink, OnJump or OnRVMouseMove).


See also:

RichView hypertext.