SCREEN PUT_WITH_SCROLL

SCREEN PUT_WITH_SCROLL writes text to a specified window, beginning at the current line.  Once text reaches the bottom or top line, subsequent execution of this statement/command causes the window to scroll.

If wrap-around is specified and the text exceeds the right most boundary of the window, another line is written and the window is scrolled, if necessary.  If co-rap around is not specified, the overflow characters are discarded.

Use PUT_WITH_SCROLL to insert a line into a window and scroll the window lines.  First define the scrolling region with the SCREEN SET_WINDOW_SCROLL_REGION command and then write the line to the beginning of the new scrolling region.

SYNTAX

SCREEN PUT_WITH_SCROLL /USING/ window_id string direction rendition wrap_flag

window_id

is an integer system field, Global Storage (GS) field, or user-defined field that contains the window ID assigned to the window.

string

is a string expression that specifies the character string to be written.

direction

specifies the direction of the scroll.  The valid values are:

  • @UP moves the window in an upward direction.
  • @DOWN moves the window in a downward direction.

rendition

specifies the video attributes of the written text.  More than one attribute may be defined by separating the attributes with plus signs.
   

The valid video attributes are:

  • NORMAL specifies normal video attribute. [default setting]
  • BLINK specifies blinking video attribute.
  • BOLD specifies bold face video attribute.
  • REVERSE specifies reverse video attribute.
  • UNDERLINE specifies underlining video attribute.

wrap_flag

specifies if the line will wrap-around when the text does not fit on the line.  The valid values are:

  • @WRAP causes the line to wrap-around.
  • @NOWRAP causes any excess characters to be discarded.

EXAMPLE

SCREEN PUT_WITH_SCROLL HELP_ID, &
     'The UPDATE command changes' + &
     'values in selected fields in the master Data Set.', &
     @DOWN NORMAL @WRAP

This example displays a help message at the current line of the HELP_ID window.  The screen scrolls down when it reaches the bottom line.  If the text does not fit on the line, the line wraps around.

SEE ALSO:  SCREEN SET_WINDOW_SCROLL_REGION (later in this section).

Back to Statements and Commands    Next page SCREEN REPAINT_SCREEN