XPRINT GET OVERLAP statement

Purpose | Retrieves the status of XPrint Overlap Mode.
Syntax | XPRINT GET OVERLAP To OverlapVar& Function Form: OverlapVar& = XPRINT(OVERLAP)

Remarks

XPRINT GET OVERLAP retrieves the status of overlap mode and assigns it to the variable specified by OverlapVar&. If Overlap Mode is enabled, the value true (non-zero) is assigned. If it's disabled, the value false (zero) is assigned instead. The value returned reflects the status of the host printer which is currently attached to the XPrint stream.

With Overlap Mode, you can control how PowerBASIC treats XPrint operations which involve a bounding rectangle (RECT structure) in their definition. Windows maintains unique conventions for a RECT. The bottom and right coordinates of a RECT are exclusive. In other words, the pixels at the bottom and right edges lie immediately outside the rectangle. They are ignored. For example:

XPRINT BOX (0,0) - (50,50)

In this case, a box is drawn from 0,0 to 49,49. The final pixels at the bottom and right edge are simply not drawn. However, if Overlap Mode is enabled with XPRINT SET OVERLAP, the box is drawn from 0,0 to 50,50.

The Overlap Mode affects all XPRINT functions which take a bounding rectangle as a parameter. This includes XPRINT SCALE, XPRINT BOX, XPRINT ELLIPSE, XPRINT LINE, XPRINT POLYLINE, etc.

See also | XPRINT SET OVERLAP