This page contains all the methods and properties that are supported by all versions of the component. Depending on the version that you are using some of the methods may not be avaiable to you. We will follow the following convention for describing methods.

• Methods Names - Blue
• Method parameters - Bold black

Methods

• GetImageSize
  • bstrSourcercImageFile - Source image file path
  • ImageObject is returned. It supports two properties, Width and Height. Use these properties to get image size information.
• CreateThumbnail
  • SourceFile - Used to specify the path for source image
  • DestFile = Used to specify the path for thumnail image file.
  • Width - Used to specify width of thumbnail
  • Height - Used to specify height of thumbnail
  • ModificationBy - Used to specify method to be used to calculate the size of thumbnail image.
    • 0 - MODIFY_ABSOLUTE, The method will use the values specified in Width and Height parameters as size of the thumbnail.
    • 1 - MODIFY_PERCENTAGE, The method will calculate the thumnail dimensions as percentage of the source image size. If you choose this method, the values of Width and Height parameters should be between 0 and 100.
  • Format - Used to specify image format for destination thumbnail file. Currently the component supports the following formats.
    • 0 - bmp
    • 1 - jpeg
    • 2 - gif
    • 3 - png
    • 4 - tiff
• CreateThumbnailEx This method is for version 2.7 and higher. It should only be used to resize GIF images with transparent pixels.
  • SourceFile - Used to specify the path for source image
  • DestFile = Used to specify the path for thumnail image file.
  • Width - Used to specify width of thumbnail
  • Height - Used to specify height of thumbnail
  • ModificationBy - Used to specify method to be used to calculate the size of thumbnail image.
    • 0 - MODIFY_ABSOLUTE, The method will use the values specified in Width and Height parameters as size of the thumbnail.
    • 1 - MODIFY_PERCENTAGE, The method will calculate the thumnail dimensions as percentage of the source image size. If you choose this method, the values of Width and Height parameters should be between 0 and 100.
  • Format - Used to specify image format for destination thumbnail file. Currently the component supports the following formats.
    • 0 - bmp
    • 1 - jpeg
    • 2 - gif
    • 3 - png
    • 4 - tiff
• WriteTextOnImage
  • SourceFile - Used to specify the path for source image
  • DestFile = Used to specify the path for thumnail image file.
  • Text - Text string that needs to be written on the image.
  • PosType - Used to specify position where text needs to be drawn on image. This variable can have one of the following value.
    • 0 - TopLeft, The text will be drawn on upper left corner of image.
    • 1 - TopRight, The text will drawn on upper right corner of image.
    • 2 - BottomLeft, The text will be drawn on lower left corner of image.
    • 3 - BottomRight, The text will be drawn on lower right corner of the image/
    • 4 - TopCenter, The text will be drawn on top center position of the image.
    • 5 - BottomCenter, The text will drawn on lower centre position of the image.
    • 6 - Center, The text will be drawn in the middle of the image.
    • 7 - Custom, The text will be drawn at the position specified by x and y parameters.
  • x - X-corodinate of the position where text should be drawn. This value if only used if PosType parameter value is set to Custom.
  • y - Y-corodinate of the position where text should be drawn. This value if only used if PosType parameter value is set to Custom.
  • FontObject - You can specify the font to be used for drawing text. This object can be obtained by calling GetFontObject method on ImageEngine object.
  • ColorObject - You can specify the color to be used for drawing text. This object can be obtained by calling GetColorObject method on ImageEngine object. You can specify R,G,B and A values for this object.
  • Format - Used to specify image format for destination file. Currently the component supports the following formats.
    • 0 - bmp
    • 1 - jpeg
    • 2 - gif
    • 3 - png
    • 4 - tiff
• MergeImages
  • BaseImageFile - Used to specify the path for source image
  • MaskImageFile - Used to specify the path for source image
  • DestFile = Used to specify the path for thumnail image file.
  • PosType - Used to specify position where mask image should be drawn on the base image. The parameter can have one of the following values.
    • 0 - TopLeft, The mask image will be drawn on upper left corner of image.
    • 1 - TopRight, The mask image will drawn on upper right corner of image.
    • 2 - BottomLeft, The mask image will be drawn on lower left corner of image.
    • 3 - BottomRight, The mask image will be drawn on lower right corner of the image/
    • 4 - TopCenter, The mask image will be drawn on top center position of the image.
    • 5 - BottomCenter, The mask image will drawn on lower centre position of the image.
    • 6 - Center, The mask image will be drawn in the middle of the image.
    • 7 - Custom, The mask image will be drawn at the position specified by x and y parameters.
  • x - X-corodinate of the position where mask image should be drawn. This value if only used if PosType parameter value is set to Custom.
  • y - Y-corodinate of the position where mask image should be drawn. This value if only used if PosType parameter value is set to Custom.
  • Format - Used to specify image format for destination file. Currently the component supports the following formats.
    • 0 - bmp
    • 1 - jpeg
    • 2 - gif
    • 3 - png
    • 4 - tiff
• CreateGreyScaleImage
  • SourceImagePath - Used to specify the path for source image
  • TargetImagePath = Used to specify the path for destination image file.
  • DestinationImageFormat - Used to specify image format for destination thumbnail file. Currently the component supports the following formats.
    • 0 - bmp
    • 1 - jpeg
    • 2 - gif
    • 3 - png
    • 4 - tiff
• InvertColors
  • SourceImagePath - Used to specify the path for source image
  • TargetImagePath = Used to specify the path for destination image file.
  • DestinationImageFormat - Used to specify image format for destination thumbnail file. Currently the component supports the following formats.
    • 0 - bmp
    • 1 - jpeg
    • 2 - gif
    • 3 - png
    • 4 - tiff
• ApplyColorFilter
  • SourceImagePath - Used to specify the path for source image
  • TargetImagePath = Used to specify the path for destination image file.
  • ColorToApply - You can specify the color to be used for applying the filter.
  • DestinationImageFormat - Used to specify image format for destination thumbnail file. Currently the component supports the following formats.
    • 0 - bmp
    • 1 - jpeg
    • 2 - gif
    • 3 - png
    • 4 - tiff
• Brighten
  • SourceImage - Used to specify the path for source image
  • TargetImagePath = Used to specify the path for destination image file.
  • Factor - You can specify the brightness factor that should be appliced to the image. This value should be between -255 and 255.
• Contrast
  • SourceImage - Used to specify the path for source image
  • TargetImagePath = Used to specify the path for destination image file.
  • Factor - You can specify the contrast factor that should be appliced to the image. This value should be between -100 and 100.
• DrawBorder
  • SourceImage - Used to specify the path for source image
  • TargetImage = Used to specify the path for destination image file.
  • BorderColor - You can specify the color to be used for applying the filter.
  • Width -Width of the border. This value should not exceed the width or height of the source image. Use a reasonable value according to your requirement.
• Emboss
  • SourceImage - Used to specify the path for source image
  • TargetImagePath = Used to specify the path for destination image file.
• GetColorObject
  • ImageColor object is returned. It supports four properties, A,R,G and B. Use these properties to set color RGBA values.
• GetFontObject
  • ImageFont object is returned. Use these properties to set font properties to be used for drawing text.