RgnEnabled Property

Description

Gets or sets whether the image processing update Region is enabled or disabled.

Property Type

Read-write property

Syntax

Visual Basic
Public Property RgnEnabled As Boolean

Return Type

True to enable the image processing update region.

False to disable the update region and all image processing occurs on the whole image.

Remarks

Specifies whether the update area in the current image, where subsequent image processing functions are performed, is either a region or the entire image. The RgnEnabled property in conjunction with the RgnAddPoint and RgnCreate methods provides the capability of performing image processing functions on non rectangular portions of the image.

When set to True, the update area in the current image - where subsequent image processing functions are performed - is the current region.
When set to False, the update area in the current image - where subsequent image processing functions are performed - is the entire image.

The current region is defined by invoking the RgnCreate method. If no region exists, the update area in the current image is the entire image.