TCustomRichView.GetCheckpointY

<< Click to display table of contents >>

TCustomRichView.GetCheckpointY

Returns vertical coordinate of the no-th checkpoint

function GetCheckpointY(no: Integer): TRVCoord;

The first checkpoint has index (i.e. no parameter) = 0.

The coordinate is relative to the top of document (top of scrollable area)

You can use the returned value to scroll document to this checkpoint.

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

Note: this function contains some calculations inside (iterations through checkpoints, from the 0-th to the no-th checkpoint).

This function ignores checkpoints in table cells.

See also methods:

GetCheckpointYEx;

GetCheckpointXY;

ScrollTo.

See also:

"Checkpoints";

Vertical scrolling.