GetVerticalPosInLayout

 

Description

 

Returns the vertical position in the page layout of any character in the pure text.

 

Arguments

 

Name

Type

I/O

Description

Nhandle

ObjectHandle

In

The page of interest (blank for the current page).

OffsetInPureText

Long Integer

In

The offset of the character pure text.

 

Return Value

 

Long Integer: when zero or positive, this is the vertical pixel location of the pure-text character identified by the OffsetInPureText argument.

 

Error returns are:

 

-1

The specified character by OffsetInPureText does not appear in the layout (i.e. it a space that is never rendered).

-2

The nHandle argument is invalid.

 

Remarks

 

The returned value is the absolute pixel position of the left edge of a pure-text character within the HTML page layout. This will differ from the position of the character in the rendering window when the window is scrolled vertically.

 

Use the GetHorizontalPosInLayout method to get the horizontal position of any pure-text character.