<< Click to display table of contents >> TCustomRichView.GetJumpPointY

Returns vertical coordinate of the hypertext link (hotspot, hot-picture or text hypertext), identified by id

function GetJumpPointY(id: Integer): TRVCoord;

Parameter

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

Return value

You can use the returned value to scroll document to the position of this link (useful when implementing "Back" button functionality)

If there is no link with such id, the method returns 0 (top of the document)

This method must be called only when the document is formatted.

 

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

 

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

 

See also methods:

▪ScrollTo

See also:

▪RichView Hypertext