ClipImage Method

Copies the pixels for a field from a full-page image into a new image.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Function ClipImage( _
   ByVal workspace As FormDirector, _
   ByVal fullImage As Image _
) As Image

'Usage
 
Dim instance As Field
Dim workspace As FormDirector
Dim fullImage As Image
Dim value As Image
 
value = instance.ClipImage(workspace, fullImage)

public Image ClipImage( 
   FormDirector workspace,
   Image fullImage
)

public:
Image^ ClipImage( 
   FormDirector^ workspace,
   Image^ fullImage
)

Parameters

workspace: An object used to set environment settings, such as debugging and licensing. See the FormDirector class for more details.
fullImage: An image of the full form. This method will copy pixels from this image to the returned image.

Return Value

A new image whose width and height match the size of this field and which contains the pixels from that lie within the field.

Remarks

This method creates a new image whose size matches this field. It then finds the pixels in fullImage that lie within the field and copies them to the new image.

This object has several different implementations of this method, each using a different format for the image. This allows you to work with the image format that is most convenient to you.

Reference

Field Class
Field Members
ClipBitmap Method
ClipHbitmap Method
ClipHdib Method
Location Property