SelectImageVariant (ImageKit Control/ Effect Method)

This method allows you to define an area on a raster image and create a new image and mask image from that area.

[Visual Basic] [ Boolean = ]imagekitcontrolname.Effect.SelectImageVariant(x As Variant, y As Variant, Red As Integer, Green As Integer, Blue As Integer)

[VB.NET] [ Boolean = ]imagekitcontrolname.Effect.SelectImageVariant(ByRef x As Object, ByRef y As Object, Red As Short, Green As Short, Blue As Short)

[C#.NET] [ bool = ]imagekitcontrolname.Effect.SelectImageVariant(ref object x, ref object y, short Red, short Green, short Blue)

Parameters

Name	Explanation
x	An array of x coordinate values defining points of a polygonal area on the image. (in pixels) *(see Note below)
y	An array of y coordinate values defining points of a polygonal area on the image. (in pixels) *(see Note below)
Red	The red component of the color painted outside the area selected. (from 0 to255)
Green	The green component of the color painted outside the area selected. (from 0 to255)
Blue	The blue component of the color painted outside the area selected. (from 0 to255)
* NOTE for retrieving array values: In Visual Basic / VB.NET, if the array is defined as Dim x(0 To 2), then the arguments are returned in x. In C#.NET the arguments are returned in ref x.

Return Value

Returns True (nonzero) if successful, otherwise returns False (0).

Explanation

The SelectImageVariant method allows you to select an area on a raster image and create a new image and mask image from this selected area.

This method is recommended when using scripting or other languages that require variant types or when using 64 bit builds in VB.NET or C#.

To execute the SelectImageVariant method, set the image handle of the image in the ImageHandle property or the Layer(LayerNo).ImageHandle property. The SelectImageVariant method supports 1, 4, 8, 16, 24, and 32 bit images.

Before executing the SelectImageVariant method, you must set the area on the image that will be affected.

To process the total image, set the SelectMode property to 1
To process the polygonal area on the image, set the SelectMode property to 2. Select the polygon by setting the appropriate coordinate values for the points of the polygon in two arrays, one array for the x coordinate values and one array for the y coordinate values. The pass these arrays to the x and y arguments of the SelectImageVariant method. The number of points defining the polygon must be 3 or more
To process an elliptical area on the image, set the SelectMode property to 3. Select the ellipse by setting the appropriate values for the bounding rectangle in the RectLeft, RectTop, RectRight, and RectBottom properties

When the SelectMode property is set to values other than 2 (ikEffectPolygon), please set dummy arrays in the x and y parameters. When the SelectMode property is set to 2 or 3, the appropriate value must be set in the InOut property.

If successful the resulting raster image data is set in the LayerNo property (the ImageHandle property or the Layer(LayerNo).ImageHandle property. The resulting mask image is set in the MaskImageHandle property. If unsuccessful, 0 is returned. The color defined by the Red, Green, and Blue parameters wil be painted in the resulting image in the area that is outside the selected area. The resulting mask image will be a black and white, 1 bit color image where the selected area is white and the area outside of the select area is black.

When the Caption, Message, and ButtonName properties are blank, the progress dialog box will not be displayed. When the progress dialog box is displayed, the percentage that the processing has completed will be shown in the dialog box.

Note: To select a portion of an image, without creating a mask image, please use the CutRectImage method. This method is much faster than the SelectImageVariant method.

Also see the SelectImage method.