PrintWindow() Function
- Last UpdatedOct 01, 2019
- 1 minute read
In a script, you can print an InTouch window with the PrintWindow() function.
Note: Scripts containing the PrintWindow() function cannot print the following Industrial graphic controls within an InTouch window: ListBox, DateTimePicker, CalenderControl, EditBox, CheckBox, RadioButtonGroup, ComboBox, AlarmClient or TrendClient.
Syntax
[result = ] PrintWindow (windowname, leftmargin, topmargin, width, height, options);
Parameters
windowname
The name of the window to be printed. A literal string value, message tagname, or string expression.
leftmargin
Left margin offset (in inches). A literal numeric value, analog tagname, or numeric expression.
topmargin
Top margin offset (in inches). A literal numeric value, analog tagname, or numeric expression.
width
Printout width (in inches). Set this value to 0 for largest aspect ratio. A literal numeric value, analog tagname, or numeric expression.
height
Printout height (in inches). Set this value to 0 for largest aspect ratio. A literal numeric value, analog tagname, or numeric expression.
options
A discrete value, 0 or 1, that is only used if width and height are 0. A literal Boolean value, discrete tagname or Boolean expression. Set to:
1 - The window is printed with the largest aspect ratio that is an integer multiple of the window size.
0 - The window is printed with the largest aspect ratio that fits on the page.
Note: If the window contains a bitmap, set options to 1 to prevent the bitmap from being stretched.
Return Value
0 - Printing job is not queued successfully, or window does not exist
1 - Printing job is queued successfully