Creates an image file that represents a snapshot of the currently loaded display.

Namespace: Ico.Gwx
Assembly: GwxRuntimeViewControl (in GwxRuntimeViewControl.dll) Version: 10.97.212.0 (10.97.212.00)

Syntax

C#
public bool ExportBitmapCaptureOfDisplay(
	string filename,
	GwxRuntimeViewControl..::..PrintAreaOptions captureArea,
	double scaleFactor
)
Visual Basic
Public Function ExportBitmapCaptureOfDisplay ( _
	filename As String, _
	captureArea As GwxRuntimeViewControl..::..PrintAreaOptions, _
	scaleFactor As Double _
) As Boolean
JScript
public function ExportBitmapCaptureOfDisplay(
	filename : String, 
	captureArea : GwxRuntimeViewControl..::..PrintAreaOptions, 
	scaleFactor : double
) : boolean

Parameters

filename
Type: System..::..String
The filename to which to save the snapshot image.
captureArea
Type: Ico.Gwx..::..GwxRuntimeViewControl..::..PrintAreaOptions
The area to capture in the snapshot (current view or entire display).
scaleFactor
Type: System..::..Double
Amount by which to scale the captured image. The value must be greater than 0.0 and less than or equal to 1.0 (100%).

Return Value

True for success, false if there was an error creating the image file.

Remarks

The type of image file to create (jpg, png, gif, bmp, tif) is inferred from the file extension of the specified filename.

See Also