OutputLayoutManager.SaveWorkspaceImage(String, String, Variable, Variable) Method

Top 

Description

Captures an image of the workspace at the native resolution, scales it using the specified parameters, and then saves it.

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

 

Method Signature

OutputLayoutManager.SaveWorkspaceImage(

String saveAsType,


String filename,


Variable scaleDimension,


Variable scaledSize)

 

 

Arguments

saveAsType


Description:

The type of image you wish to save.

Valid Values:

Value

Label

"BMP"

BMP

"GIF"

GIF

"JPEG"

JPEG

"PNG"

PNG

"TIFF"

TIFF

"EMF"

EMF

"PDF"

PDF

 

 

 

filename


Description:

The file to which the Workspace image will be saved.

 

 

scaleDimension


Description:

Determines whether width or height will be scaled to the specified size.

Valid Values:

Value

Label

0

Width

1

Height

 

 

 

scaledSize


Description:

The final size of the scaled dimension.

Units:

pixel

Valid Range:

scaledSize > 0

 

 

 

Syntax

OutputLayout.SaveWorkspaceImage(myString1, myString2, myVariable1, myVariable2);

 

 

See also

OutputLayoutManager Object

OutputLayoutManager.SaveWorkspaceImage

Output Layout Control Guide