Cls

(Engine-Level Function)

Description:	Clears the screen and sets its background color.
Returns:	Nothing
Usage:	Script or steady state.
Function Groups:	Color, Graphics, Window
Related to:	GetSystemColor
Format:	Cls(Color)
Parameters:

Color

Required. Any numeric expression giving the color to which the screen should be set.

You may use any of the following methods to specify the color:

a palette index VTScada Color Palette
a system color Constants for System Colors
an RGB string with optional Alpha value in the format, "<AARRGGBB>", or "<RRGGBB>", where AA, RR, GG and BB are hexadecimal digits.

Note that Cls will ignore the alpha channel if you provide the color as an <AARRGGBB> string, since the background color of a window cannot have an alpha value that is different from the window itself.

Comments:

This statement sets the background color for the window that the function is executed within. It will clear the screen but any layered graphics such as GUI or Z-graphic functions will be redrawn.

The description of the color parameter mentions that Cls will ignore alpha (transparency) values. Note also that you cannot set the background color of windows that use their background as a transparency mask (bit 18 set in the Style parameter).

Cls will work on both workstations and on thin clients.

Example:

  Cls(1);

This sets the window background color to dark blue.