Multiple Image Resizer .NET v4.5.2
Help Documentation
Contents

Scripting Function - UnderlayImage

The function underlays a specified image beneath each image, the function performs a reverse of the OverlayImage function. The location of the image overlay is specified by x and y coordinates.

 

Syntax

Underlay underlayimagefile As StringValueFileNameExisting, transparencymethod As OverlayTransparencyMethod, transparentcolor As ArgbColorValue, x As IntegerValueGreaterEqualZero, y As IntegerValueGreaterEqualZero, transparencyPercentage As IntegerValuePercentage

 

Parameters

underlayimagefile - the full path of the image file that you would like to underlay beneath each image

transparencymethod - the overlay transparency method used during the overlay operation

transparentcolor - the color in the overlay image that will be made transparent during the overlay operation. Note if you have chosen to use ExistingImageTransparency for the transparencymethod parameter then this color parameter will not be used, but you specify it anyway!

x - the x coordinate where the top left corner of the overlay image should be positioned

y - the y coordinate where the top left corner of the overlay image should be positioned

transparencyPercentage - Optional Parameter - Specifies the overall transparency (in percent) of the overlay image (defaults to 0 if not specified).

 

Example

The following example overlays an image file onto each image. The overlay image file already has an existing transparent layer which we want to use so we set the transparencymethod parameter to ExistingImageTransparency, the top left corner of the overlay image is positioned 50 pixels from the left edge and 80 pixels from the top edge of the images:

UnderlayImage "c:\temp\image34.gif", ExistingImageTransparency, Argb(0, 0, 0, 0), 50, 80

 

Version Information

Supported in Multiple Image Resizer .NET v4.0.0.3

 

See Also