Clears the specified area of a specified image, and fill the area with the fill color.

Namespace: Dynamsoft.DotNet.TWAIN
Assembly: DynamicDotNetTWAIN (in DynamicDotNetTWAIN.dll) Version: 3.0.0.0 (3.0.0.0)

Syntax

C#
public bool Erase(
	short sImageIndex,
	int iLeft,
	int iTop,
	int iRight,
	int iBottom
)
Visual Basic
Public Function Erase ( _
	sImageIndex As Short, _
	iLeft As Integer, _
	iTop As Integer, _
	iRight As Integer, _
	iBottom As Integer _
) As Boolean

Parameters

sImageIndex
Type: System..::..Int16
Specifies the index of image in buffer. The index is 0-based.
iLeft
Type: System..::..Int32
Specifies the x-coordinate of the upper-left corner of the rectangle.
iTop
Type: System..::..Int32
Specifies the y-coordinate of the upper-left corner of the rectangle.
iRight
Type: System..::..Int32
Specifies the x-coordinate of the lower-right corner of the rectangle.
iBottom
Type: System..::..Int32
Specifies the y-coordinate of the lower-right corner of the rectangle.

Return Value

True indicates success. False indicates failure.

Remarks

The fill color can be defined by BackgroundFillColor. The valid area is the intersection of specified area(defined by the input parameters) and the whole image.If the intersection is invalid, an error will be throwed out.

Exceptions

ExceptionCondition
Dynamsoft.DotNet.TWAIN..::..TwainException When an error occurs and IfThrowException property is true, an exception will be thrown. When IfThrowException property is false, please check ErrorCode and ErrorString.

See Also