18.01.2015 Views

Technical Reference Manual - InduSoft

Technical Reference Manual - InduSoft

Technical Reference Manual - InduSoft

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

Appendix: Built-in Scripting Language<br />

Returned value<br />

No returned values.<br />

Examples<br />

PrintSetup()<br />

PrintWindow<br />

Prints a screenshot of a project screen. The screen does not need to be open and active; the function can print<br />

a screen running in the background or even closed screen file.<br />

Function Group Execution Windows Embedded Thin Client<br />

PrintWindow Graphic Asynchronous Supported Supported Supported<br />

Note: This function cannot be used with Tasks or in the Global Procedures script.<br />

Syntax<br />

PrintWindow( strScreenName , optNumOrientation, optNumID, optStrMnemonicList )<br />

strScreenName<br />

The name of the screen to be printed. If this parameter is omitted, then the currently active<br />

screen will be printed. (This parameter must be omitted when executing the function on a<br />

Windows Embedded target system.)<br />

optNumOrientation<br />

A numeric flag specifying the paper orientation:<br />

Value<br />

Description<br />

optNumID<br />

0 Portrait<br />

1 Landscape<br />

Default value is 0.<br />

Note: The optNumOrientation parameter is not supported when running the<br />

project on a Windows Embedded target system.<br />

The specific instance number of the screen. (The ID is assigned when the screen is opened with<br />

the Open function.) This is an optional parameter; the default ID is 0.<br />

optStrMnemonicList<br />

A string that describes how the custom properties of any generic objects or linked symbols in<br />

the screen will be completed when the screen is printed. This string has the following syntax…<br />

#Label:Value<br />

…where Label is the name of the property and Value is the tag, expression or literal value that<br />

the property will receive. You can declare two or more mnemonics, as long as they are separated<br />

by spaces. See the Examples section below for an example.<br />

<strong>InduSoft</strong> Web Studio Page 647

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!