Area Method

Description

Specifies the update area in the current image where subsequent image processing functions are performed.

Syntax

Visual Basic
Public Sub Area( _ ByVal IPArea As Boolean, _ ByVal IPAreaX As Long, _ ByVal IPAreaY As Long, _ ByVal IPAreaWidth As Long, _ ByVal IPAreaHeight As Long _ )

Parameters

IPArea

A boolean expression that enables or disables the update area.

IPAreaX

The left component of the top-left coordinate of the area cropping rectangle.

Valid values are greater than zero.

IPAreaY

The top component of the top-left coordinate of the area cropping rectangle.

Valid values are greater than zero.

IPAreaWidth

The width of the area cropping rectangle (in pixels).

Valid values are greater than zero.

IPAreaHeight

The height of the area cropping rectangle (in pixels).

Valid values are greater than zero.

Remarks

This method provides the capability of performing image processing functions on rectangular portions of the image.

When this method is enabled (IPArea = True), all image processing methods are applied to this area. When Area is disabled (IPArea = False), all image processing methods are applied to the entire image.
If the IPAreaX or IPAreaY parameters do not fall within the boundaries of the image, the method fails and the ImagError property is set to 1035 (ErrorInvalidAreaOrRegion).
If the IPAreaX or IPAreaY parameters fall within the boundaries of the image but the IPareaWidth or IPareaHeight parameters exceed the boundaries of the image, the update area is cropped to fit within the image boundaries.

The Area method sets the IPAreaX, IPAreaY, IPAreaWidth, and IPAreaHeight properties. These properties record the value of the Area method parameters so they can be used at a later point.