Frame Class: _snapShot

Frame Class: _snapShot

Copies a snapshot of a graphical widget into the Image Data Object

Syntax
Details

Syntax

objectName._snapShot( objectID );

objectName._snapShot( objectID, successful );

objectName._snapShot( objectID,successful, snapType );

objectName._snapShot( objectID, successful,snapType,upperLeftX );

objectName._snapShot( objectID, successful, snapType,upperLeftX,upperRightY );

objectName._snapShot( objectID, successful, snapType,upperLeftX,upperRightY, width );

objectName._snapShot( objectID, successful,snapType,upperLeftX, upperRightY, width, height );

Argument Type Use Description

objectID Numeric Input specifies the object identifier of the Image Data Object that is the target of the snapshot operation

successful Numeric Output returns whether or not the _snapshot method was successfully completed: 0 if successful

snapType Character Input specifies the type of snapshot operation: BOUNDED (default), UNBOUNDED or MAIN

upperLeftX Numeric Input specifies the the upper left x pixel coordinate for explicit bounding specification

upperRightY Numeric Input specifies the the upper right y pixel coordinate for explicit bounding specification

width Numeric Input specifies the the width in pxels for explicit bounding specification

height Numeric Input specifies the the height in pxels for explicit bounding specification

Argument	Type	Use	Description
objectID	Numeric	Input	specifies the object identifier of the Image Data Object that is the target of the snapshot operation
successful	Numeric	Output	returns whether or not the _snapshot method was successfully completed: 0 if successful
snapType	Character	Input	specifies the type of snapshot operation: BOUNDED (default), UNBOUNDED or MAIN
upperLeftX	Numeric	Input	specifies the the upper left x pixel coordinate for explicit bounding specification
upperRightY	Numeric	Input	specifies the the upper right y pixel coordinate for explicit bounding specification
width	Numeric	Input	specifies the the width in pxels for explicit bounding specification
height	Numeric	Input	specifies the the height in pxels for explicit bounding specification

Details

An Image Data Object, which contains the results of the snapshot operation, must be provided. Not all objects will have a useful _snapshot image placed in the Image Data Object. Host widgets (such as push buttons and list boxes) are notable examples.

Chapter Contents
Previous
Next
Top of Page