Technical Reference Manual - InduSoft

Appendix: Built-in Scripting Language
Get the level of the component specified by TagComponent in the color specified by TagCode:
RGBComponent( TagCode, TagComponent )
SaveScreenShot
This function takes a screen shot of the project screen and saves it to an image file.
Function Group Execution Windows Embedded Thin Client
SaveScreenShot Graphic Synchronous Supported Supported (only for
open screens)
Executed on Server
Syntax
SaveScreenShot({ | optStrScreenName{ | ,optStrOutputFile{ | ,{ optNumFormat | 0 | 1 | 2 | 3 | 4
| 5 } } } })
SaveScreenShot()
SaveScreenShot( optStrScreenName )
SaveScreenShot( optStrScreenName, optStrOutputFile )
SaveScreenShot( optStrScreenName, optStrOutputFile, optNumFormat )
optStrScreenName
The name of a project screen file (*.scr). If no file path is specified, then the file must be located
in the Screen folder of the project (e.g., \projectname\Screen\screenname.scr).
For projects running on Windows, the screen may be either open or closed. For projects running
on Windows Embedded, the screen must be open.
This is an optional parameter; if no value (or "") is specified, then the currently open and active
screen is used.
optStrOutputFile
The name of the output file. If no file path is specified, then the file is saved in the Web folder of
the project (e.g., \projectname\Web\screenname.jpg)
This is an optional parameter; if no value is specified, then either the value of optStrScreenName
or simply ScreenShot.jpg is used.
optNumFormat
The format of the image file:
Value
Description
0 BMP
1 JPG
2 PNG
3 GIF
4 TIFF
5 Auto
This is an optional parameter; if no value is specified, then the default is 1 (JPG).
Returned value
This function returns the following possible values:
Page 650
InduSoft Web Studio