Adds a watermark to the loaded image.

AddWatermark takes five parameters, but only the first is required:

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	'--- Add the image in 'watermark.bmp' using all defaults
	objImageGen.AddWatermark "C:\temp\watermark.bmp"
	objImageGen.SaveImage saiBrowser, saiJPG, "c:\resize.jpg"
	

Blurs the generated image. BlurImage takes a value between 1 and 100. The image will be most blurred at 100.

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	objImageGen.LoadImage "c:\sample.jpg"
	objImageGen.BlurImage 100
	

Brightens the generated image. The higher the value of ChangeBrightness, the brighter the image.

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	objImageGen.LoadImage "c:\sample.jpg"
	objImageGen.ChangeBrightness 3
	

Creates a gradient two-color image.

Example:

CreateGradientImage takes five arguments:

Example:

Set objImageGen = Server.CreateObject("softartisans.ImageGen")
objImageGen.CreateGradientImage 600, 200, _
		rgb(0,0,255), rgb(255,255,0), saiVertical
objImageGen.SaveImage saiBrowser, saiGIF, "c:\blueandyellow.gif"
	

Generates a new image. CreateImage takes three arguments: Width, Height, and Color.

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	
	'--- Create a 500 X 500 white square
	objImageGen.CreateImage 500, 500, rgb(255,255,255)
	
	'--- Draw a blue ellipse on the image
	objImageGen.DrawEllipseOnImage 150, 200, 100, 50, true, rgb(0,0,255)
	
	'--- Save the new image as a gif file
	objImageGen.SaveImage saiBrowser, saiGIF, "c:\ellipse.gif"
	

Creates a thumbnail from the loaded image.

CreateThumbnail takes four parameters, but none are required:

Note: To ensure that an image will be a specific width and maintain the original ratio, set the Height parameter to 0. If the Height parameter is not set, ImageGen will apply the default value 200.

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	'--- Create a thumbnail, 200 pixels in height
	objImageGen.CreateThumbnail , 200
	objImageGen.SaveImage saiBrowser, saiJPG, "c:\resize.jpg"
	

Creates a two-way, gradient, two-color image.

Example:

Example:

Set objImageGen = Server.CreateObject("softartisans.ImageGen")
objImageGen.CreateTwoWayGradientImage 600, 300, rgb(0,0,255), _
		rgb(255,255,0), saiVertical
objImageGen.SaveImage saiBrowser, saiGIF, "c:\blueandyellow.gif"
	

Crops the generated image. CropImage takes four arguments:

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	objImageGen.LoadImage "c:\sample.jpg"
	objImageGen.CropImage 50,30,150,100
	

Draws an ellipse on an image. DrawEllipseOnImage takes six arguments:

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	objImageGen.CreateImage 500, 500, rgb(255,255,0)
	objImageGen.DrawEllipseOnImage 150, 250, 100, 50, True, rgb(0,0,255)
	objImageGen.SaveImage 2, saiJPG, "c:\ellipse.jpg"
	

Draws an a line on an image. DrawLineOnImage takes five arguments:

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	objImageGen.CreateImage 500, 500, rgb(255,255,0)
		
	'--- Draw a line from the top left corner of the image 
	'--- to its bottom right corner
	objImageGen.DrawLineOnImage 0, 0, 500, 500, rgb(0,0,255)
	

Draws text on an image. DrawTextOnImage takes five arguments:

Use the Font object to define the look of text.

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	objImageGen.CreateImage 500, 500, rgb(255,255,0)
	objImage.DrawTextOnImage 50, 50, 100, 1, "Yellow Square"
	

Draws a color-filled rectangle on an image. FillRectInImage takes five arguments:

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	
	'--- Create a yellow square image  
	objImageGen.CreateImage 500, 500, rgb(255,255,0)

	'--- Draw a white 100 X 50 rectangle on the yellow image
	objImageGen.FillRectInImage 50, 150, 100, 50, rgb(255,255,255)	
	

Flips an image vertically or horizontally. Assign the flip direction by name or number:

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	objImageGen.LoadImage "c:\sample.jpg"
	objImageGen.FlipImage saiFlipVertical	
	

Inverts the image from negative to positive or positive to negative. This method has no parameters.

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	objImageGen.LoadImage "c:\sample.jpg"
	objImageGen.InvertImage
	

Loads an existing image. Once the image is loaded, you can use ImageGen's methods and properties to edit it and save the new image. LoadImage can accept either a file or a byte array as an image source. Note: If you save the edited image with a new file name, you will not overwrite the original image.

Examples:

In the following example the image source is a file.

Set objImageGen = Server.CreateObject("softartisans.ImageGen")
objImageGen.LoadImage "c:\sample.jpg"	
objImageGen.FlipImage saiFlipHorizontal
objImageGen.SaveImage saiFile, saiGIF, "c:\sample.gif"	

In the following example the image source is a byte array. The image is retrieved from the image collection.

Dim byteArr
byteArr = objImages("Img3")
Set objImageGen = Server.CreateObject("softartisans.ImageGen")
objImageGen.LoadImage byteArr

Merges a specified image with the loaded or created image. MergeWithImage takes five arguments:

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	objImageGen.CreateImage 500, 500, rgb(255,0,0)
	objImageGen.MergeWithImage 50, 300, "c:\sample.jpg", 0.2, 1
	objImageGen.SaveImage saiFile, saiGIF, "c:\mergedimage.gif"
	

Resizes the image to specified width and height. ResizeImage takes four arguments:

Width	Width, in pixels, of the resized image.
Height	Height, in pixels, of the resized image.
ResizeAlgorithm	Optional. Assign ResizeAlgorithm by name or number, according to the table below.	Default value: 0
MaintainProportions	Optional. If set to 1, height to width proportions will be maintained after resizing.	Default value: 1

Note: To ensure that an image will be a specific width and maintain the original ratio, set the Height parameter to 0. If the Height parameter is not set, ImageGen will apply the default value 200.

ResizeAlgorithm Values
saiBilinear	0	The image will be resized using bi-linear interpolation, which is much faster than bi-cubic interpolation.
saiNearestNeighbor	1	The image will be resized using nearest-pixel resampling. This will work with colormapped images.
saiBicubic	2	The image will be resized using bi-cubic interpolation, which is much slower than bi-linear interpolation, but produces a slightly better result.
saiFilterImage	3	This algorithm should only be used on continuous-tone images, such as, RGBA, RGB, and grayscale. Use this algorithm to preserve image quality when reducing an image. The algorithm will use the type of filter set by the ResizeFilter property.

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	objImageGen.LoadImage "c:\sample.jpg"
	objImageGen.ResizeImage 100, 200, saiNearestNeighbor, 0
	objImageGen.SaveImage saiFile, saiJPG, "c:\resize.jpg"	
	

Rotates an image a specified number of degrees clockwise. RotateImage takes two arguments:

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	objImageGen.CreateImage 100, 200, rgb(255,0,0)
	objImageGen.RotateImage 45, rgb(0,0,255)
	

Saves the generated image. SaveImage takes three arguments:

SaveMethod	Specifies whether to stream the image to the browser, save it as a file, save it in memory, or save it as a database blob. Assign SaveMethod by name or number according to the table below.
ImageFormat	Specifies one of nine supported image file types. Assign ImageFormat by name or number according to the table below.
SaveData	Set SaveData to the complete file path and name for saving.

SaveMethod Values
saiFile	0	Save the image as a file.
saiMemory	1	Save the image in memory. If SaveMethod is set to saiMemory, SaveImage will return the byte array saved in memory.
saiBrowser	2	Stream the image to the browser.
saiDatabaseBlob	4	Save the image as a database blob.

ImageFormat Values
saiBMP	1	saiTIFF Note: ImgWriter will not read a TIFF image with LZW compression.	6
saiGIF	2	saiWMF	7
saiJPG	3	saiEMF	8
saiPNG	4	saiPSD	9
saiPCX	5

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	objImageGen.LoadImage "c:\sample.jpg"
	objImageGen.FlipImage 1
	objImageGen.SaveImage 2, saiGIF, "sample.gif"

Sharpens the generated image. SharpenImage takes a value between 1 and 100. The image will be sharpest at 100.

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	objImageGen.LoadImage "c:\sample.jpg"
	objImageGen.SharpenImage 100
	

Anti-aliasing smoothes the jagged edges of diagonal lines and curves. When anti-aliasing is enabled, ImgWriter will test the color of sharp points on the edge of the image, calculate intermediate shades, and color the background area between sharp points with the appropriate intermediate shade. This blurs the colors along a curved or diagonal edge, making the edge appear smoother. Set AntiAliasFactor to an SAAntiAliasFactor value by name or number.

SAAntiAliasFactor Values:

Higher AntiAliasFactor values require more memory and are therefore slower. SaAntiAliasBest (4) is the recommended value.

When anti-aliasing is not used, a text rectangle's dimensions are calculated based on the Top, Left, Height, and Width parameters passed to DrawTextOnImage (the text will be truncated if it exceeds the Width parameter value). When anti-aliasing is enabled, the Width and Height values of DrawTextOnImage are ignored and the dimensions of a text rectangle are determined by the font dimensions.

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	objImageGen.CreateImage 500, 500, rgb(255,255,0)
	objImageGen.DrawTextOnImage 50, 50, 100, 1, "Yellow Square"
	objImageGen.AntiAliasFactor = saAntiAliasBest
	

Use BufferResponse when streaming an image to the client to turn ASP response buffering on or off. By default, BufferResponse is set to False (off). When ASP buffering is off, the image is streamed to the browser using chunked transfer encoding.

Internet Explorer issue: IE cannot handle a refresh of a page that is sent using chunked transfer encoding (this is not an issue in Netscape). The BufferResponse property allows you to turn on buffering to enable refreshes in IE, at a cost of higher memory utilization on the server.

Sets or returns an image color selection method as an enum of type SAIImageColorSelectMethod. This property determines how the image's RGB values will be mapped to the available color palette when saved. Set ColorAdjustmentAlgorithm by name or number, according to the following table.

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	objImageGen.LoadImage "c:\sample.jpg"	
	objImageGen.ColorAdjustmentAlgorithm = saiNetscapeBestFit
	objImageGen.SaveImage saiFile, saiGIF, "c:\sample.gif"
	

Sets the generated image's color resolution. Assign ColorResolution by name or number according to the following table.

Example:

	Set objImage = Server.CreateObject("softartisans.ImageGen")
	objImage.LoadImage "c:\sample.jpg"
	objImage.ColorResolution = saiGrayScale
	objImage.SaveImage 2, saiGIF, "c:\sample2.gif"
	

Sets or returns an image's horizontal DPI (Dots Per Inch). Depending on the value of the DPIunits property, DPIx will set/return dots per inch, centimeter, or meter.

Example:

Set objImage = Server.CreateObject("softartisans.ImageGen")
objImg.LoadImage "C:\image.jpg"
...
objImage.DPIx = 150
objImage.DPIy = 150
objImage.DPIUnits = saiDotsPerCm
...

Top

Sets or returns an image's vertical DPI (Dots Per Inch). Depending on the value of the DPIunits property, DPIy will set/return dots per inch, centimeter, or meter.

Example:

Set objImage = Server.CreateObject("softartisans.ImageGen")
objImg.LoadImage "C:\image.jpg"
...
objImage.DPIx = 150
objImage.DPIy = 150
objImage.DPIUnits = saiDotsPerCm
...

Top

Sets or returns a unit for measuring DPI (Dots Per Inch). Use with the properties DPIx and DPIy. Set DPIunits by name or number:

Example:

Set objImage = Server.CreateObject("softartisans.ImageGen")
objImg.LoadImage "C:\image.jpg"
...
objImage.DPIx = 150
objImage.DPIy = 150
objImage.DPIUnits = saiDotsPerCm
...

Top

Returns an error description.

Example:

	On error resume next
	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	
	'--- Try to load an image that does not exist
	objImageGen.LoadImage Server.MapPath(Application("vroot") &_
		"samples/tutorial/images/flowers.gif")
	
	'--- Display an error description
	If objImageGen.ErrorDescription <> "" Then
		Response.Write objImageGen.ErrorDescription
	End If
	

Returns a Font object. Use the properties of Font to define the appearance of text on an image (see DrawTextOnImage).

Example:

	Set objImage = Server.CreateObject("softartisans.ImageGen")
	objImage.CreateImage 500, 500, rgb(255,255,204)
	Set objFont = objImage.font
	objFont.height = 50
	objFont.name = "verdana"
	objFont.color = rgb(221,0,0)
	objImageGen.DrawTextOnImage 50, 50, 300, 1, "Text"	
	

Returns the height of an image.

Example:

Set objImageGen = Server.CreateObject("softartisans.ImageGen")
objImageGen.LoadImage "D:\images\olivetrees.jpg"
objImageGen.ResizeImage (objImageGen.Width)*2, (objImageGen.Height)*2, _
				saiNearestNeighbor
	

Is a read-only property that returns the format of an image as an SAImageFormat enum type. SAImageFormat contains the following members:

Example:

Set objImageGen = Server.CreateObject("softartisans.ImageGen")
objImageGen.LoadImage "D:\images\olivetrees.jpg"
Dim imgFormat
imgFormat = objImageGen.ImageFormat
		

Sets or returns the quality of a jpeg image. ImageQuality is the inverse of compression. That is, the higher the value of ImageQuality, the larger the image data. ImageQuality may be any value between 1 and 100.

Example:

Set objImageGen = Server.CreateObject("softartisans.ImageGen")
objImageGen.LoadImage "D:\images\olivetrees.jpg"
objImageGen.ImageQuality = 100
objImageGen.SaveImage saiBrowser, saiJPG, "c:\images\olivetrees.jpg"

When set to True, the entire jpeg image will be rendered immediately in poor quality, and its quality will be progressively improved. When set to False, the jpeg image is rendered piece by piece, but at full quality. JPEGProgressive is set to True by default.

Example:

Set objImageGen = Server.CreateObject("softartisans.ImageGen")
objImageGen.LoadImage "D:\images\olivetrees.jpg"
objImageGen.JPEGProgressive = False
objImageGen.SaveImage saiBrowser, saiJPG, "c:\images\olivetrees.jpg"

If you set the third parameter of ResizeImage to saiFilterImage, set ResizeFilter to the type of filter the resize algorithm should use.

Set ResizeFilter to a number from 0 to 13:

ResizeFilter is a Read/Write property. The default value is 4.

Example:

	Set objImageGen = Server.CreateObject("softartisans.ImageGen")
	objImageGen.LoadImage "c:\sample.jpg"
	objImageGen.ResizeImage 100, 200, saiFilterImage, 0
	objImageGen.ResizeFilter = 2
	objImageGen.SaveImage saiFile, saiJPG, "c:\resize.jpg"
	

The string that will be added to the image when DrawTextOnImage is called.

Example:

Set objImageGen = Server.CreateObject("softartisans.ImageGen")
objImageGen.CreateImage 300, 50, rgb(0,255,255)
objImageGen.Font.Italic = True
objImageGen.Font.Height = 20
objImageGen.Text = "The current time is " & Time
objImageGen.DrawTextOnImage 10, 10, objImageGen.TextWidth, objImageGen.TextHeight
objImageGen.SaveImage saiBrowser, saiJPG, "C:\temp\time.jpg"
	

Returns the height of the string passed as the one, optional parameter. If no parameter is specified, this property returns the height of the string that was previously set as the Text property.

Example:

Set objImageGen = Server.CreateObject("softartisans.ImageGen")
objImageGen.Font.Italic = True
objImageGen.Font.Height = 20
Dim nHeight, nWidth
objImageGen.Text = "The current time is " & Time
nHeight = objImageGen.TextHeight
nWidth = objImageGen.TextWidth
objImageGen.DrawTextOnImage 10, 10, nWidth, nHeight
objImageGen.SaveImage saiBrowser, saiJPG, "C:\temp\time.jpg"

Returns the width of the string passed as the one, optional parameter. If no parameter is specified, this property returns the width of the string that was previously set as the Text property.

Example:

Set objImageGen = Server.CreateObject("softartisans.ImageGen")
objImageGen.Font.Italic = True
objImageGen.Font.Height = 20
Dim nHeight, nWidth, strTime
strTime = "The current time is " & Time
nHeight = objImageGen.TextHeight(strTime)
nWidth = objImageGen.TextWidth(strTime)
objImageGen.DrawTextOnImage 10, 10, nWidth, nHeight, strTime
objImageGen.SaveImage saiBrowser, saiJPG, "C:\temp\time.jpg"
	

ImgWriter can read individual pages of a multi-page tiff file. When loading a multi-page tiff file, before calling LoadImage, set TiffPage to the desired page.

Tiff page numbers are 1-based.

TiffPage is a Read/Write property. The default value is 1.

Example:

Set objImageGen = Server.CreateObject("softartisans.ImageGen")
objImageGen.TiffPage = 5
objImageGen.LoadImage "c:\sample.tif"
	

This property can be used with gif images. TransparentColor will make a specified color transparent.

Example:

Set objImageGen = Server.CreateObject("softartisans.ImageGen")
'--- Create a 200*200 yellow square
objImageGen.CreateImage 200, 200, rgb(255,255,204)
'--- Draw a blue circle on the yellow square
objImageGen.DrawEllipseOnImage 100, 100, 50, 50, True, rgb(0,0,255)
'--- Make blue transparent
objImageGen.TransparentColor = rgb(0,0,255)
...

Returns the width of an image.

Example:

Set objImageGen = Server.CreateObject("softartisans.ImageGen")
objImageGen.LoadImage "D:\images\olivetrees.jpg"
objImageGen.ResizeImage (objImageGen.Width)*2, (objImageGen.Height)*2,_
					saiNearestNeighbor