TakeDesktopScreenshot

<< Click to Display Table of Contents >>

Manual > Control Reference > Route > Route Methods >

TakeDesktopScreenshot

 

Save the entire desktop screen to an image file.

 

syntax

TakeDesktopScreenshot(

         file

         [,fileFormat = "bmp"]

         [,width = -1]

         [,height = -1]

         )

 

Parameters

 

fileName

 

Type:

character

 

The image file name.

 

fileFormat

 

Type:

character

 

The file format to save in.

"bmp" - bitmap files

"jpg" - jpeg file

 

width

 

Type:

Number

 

Image width in pixels. -1 means true size.

 

height

 

Type:

Number

 

Image height in pixels. -1 means native size.

 

Return Value

 

 

Type:

Boolean

 

FALSE - Failure. TRUE - Success.

 

hmtoggle_plus1Explanation

Saves the entire desktop image as it appears on the screen to an image file.

 

 

Supported

×

Script Action

Can be used in server script Ver2 actions

○

Browser script

Can be used in browser scripts

×

Calculation Expression Syntax

Can be used in expression syntax (e.g. bind syntax)

 

 

reference

 

PrintImage

GetPrinterName

PrintDesktopScreenshot

TakeDesktopScreenshot

PrintScreenshot

TakeScreenshot