GRAPHIC GET SCROLLTEXT statement

Purpose | Retrieves the status of Graphic ScrollText Mode.
Syntax | GRAPHIC GET SCROLLTEXT To ScrollVar& Function Form: ScrollVar& = GRAPHIC(SCROLLTEXT)

Remarks

GRAPHIC GET SCROLLTEXT retrieves the status of ScrollText mode and assigns it to the variable specified by ScrollVar&. If ScrollText 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 graphic target which is currently attached to the graphic stream.

With ScrollText Mode, you can control how PowerBASIC prints text on a graphic target when it reaches the end of a page. Since a graphic target operates on a full page basis, the default is to ignore text which is printed past the end of the page. This can be modified under program control by using GRAPHIC SET SCROLLTEXT.

When ScrollText Mode is enabled, scrolling of a page is triggered only by GRAPHIC PRINT. If the POS (last point referenced) is located on the bottom row of the graphic target, and a GRAPHIC PRINT statement moves the POS off of the page, the entire contents of the graphic target is scrolled one row, and a new blank row is opened at the bottom.

See also | GRAPHIC CELL, GRAPHIC SET SCROLLTEXT