ImageHelper Class

Class providing methods for image processing.

Inheritance Hierarchy

System.Object
  CMS.Helpers.ImageHelper

Namespace: CMS.Helpers
Assembly: CMS.Helpers (in CMS.Helpers.dll) Version: 13.0.131

Syntax

public class ImageHelper

The ImageHelper type exposes the following members.

Constructors

	Name	Description
Public method	ImageHelper()	Empty constructor.
Public method	ImageHelper(Byte[])	Constructor with image data to load.
Public method	ImageHelper(Byte[], Int32, Int32)	Constructor with image data to load.

Fields

	Name	Description
Public field Static member	AUTOSIZE	Used when resizing image. (Old dimensions: x = 10, y = 20; Resizing: x = AUTOSIZE; y = 10, New dimensions: x = 5, y = 10).

Properties

	Name	Description
Public property Static member	DefaultCompositingMode	Default composition mode is set to SourceCopy.
Public property Static member	DefaultCompositingQuality	Default composing quality is set to HighQuality.
Public property Static member	DefaultInterpolationMode	Default mode is set to HighQualityBicubic.
Public property Static member	DefaultPixelOffsetMode	Default offset mode is set to HighQuality.
Public property Static member	DefaultQuality	Default quality to be used when an image is being re-sized. (Default quality is set to 85% by default).
Public property Static member	DefaultSmoothingMode	Default smoothing mode is set to HighQuality.
Public property Static member	DefaultWrapMode	Default mode is set to TileFlipXY.
Public property	ImageData	Returns image data.
Public property Static member	ImageExtensions	Image extensions supported by the system
Public property	ImageHeight	Image height.
Public property	ImageWidth	Image width.
Public property Static member	JPEGEncoder	JPEG image encoder.
Public property	LastError	Last processing error.
Public property	SourceData	Source data for the image.
Public property Static member	UseFixedEnsureImageDimensions	Gets value that indicates if use of new image resizing is enabled.
Public property Static member	UseGDIForResize	Indicates if GDI resizing will be used for resizing indexed images.

Methods

	Name	Description
Public method	CanResizeImage	Indicates if current image can be resized to the specified dimensions.
Public method	EnsureImageDimensions(Int32, Int32, Int32)	Returns new image dimensions (int[2]: 0 - width, 1 - height) .
Public method Static member	EnsureImageDimensions(Int32, Int32, Int32, Int32, Int32)	Computes new image dimensions according to the specified parameters, and returns it.
Public method Static member	GetAutoResizeDimensions	Gets dimensions from settings into width, height and max side size parameters.
Public method Static member	GetAutoResizeToHeight	Returns HEIGHT the images should be automatically resized to. Value is returned from the site settings.
Public method Static member	GetAutoResizeToMaxSideSize	Returns MAX SIDE SIZE the images should be automatically resized to. Value is returned from the site settings.
Public method Static member	GetAutoResizeToWidth	Returns WIDTH the images should be automatically resized to. Value is returned from the site settings.
Public method Static member	GetBytes	Gets the binary data for the given image
Public method	GetConvertedImage	Transforms image to different format.
Public method	GetConvertedImageData	Transforms image to different format.
Public method	GetFlippedImage	Flips image.
Public method	GetFlippedImageData	Flips image.
Public method	GetGrayscaledImage	Transforms image to grayscale.
Public method	GetGrayscaledImageData	Transforms image to grayscale.
Public method	GetImage	Gets the image based on the file name. The method's return value is cached for 60 minutes.
Public method Static member	GetImageThumbnailFileName	Returns image thumbnail file name.
Public method	GetImageWithWatermarkData	Obsolete. Gets the image.
Public method Static member	GetPositionEnum	Obsolete. Gets the enumeration of the given position string.
Public method	GetResizedImage(Int32)	Returns resized image according to max side size.
Public method	GetResizedImage(Int32, Int32)	Returns resized image.
Public method	GetResizedImageData(Int32, Int32)	Returns resized image as the data array. For quality is used DefaultQuality.
Public method	GetResizedImageData(Int32, Int32, Int32)	Returns resized image as the data array.
Public method Static member	GetResizedImageData(Byte[], String, Int32, Int32, Int32)	If posted file is image, resizes it to the required dimensions if possible and returns resized data. If it is not image, original data are returned.
Public method Static member	GetResizeEnum	Returns image resize enumeration for given string.
Public method	GetRotatedImage	Rotates image by specified angle.
Public method	GetRotatedImageData	Rotates image by specified angle.
Public method	GetTrimmedImage(Int32, Int32, ImageHelper.ImageTrimAreaEnum)	Trim image by specified area.
Public method	GetTrimmedImage(Int32, Int32, Int32, Int32)	Trim image by specified area.
Public method	GetTrimmedImageData(Int32, Int32, ImageHelper.ImageTrimAreaEnum)	Trim image by specified area.
Public method	GetTrimmedImageData(Int32, Int32, Int32, Int32)	Crop image by specified area.
Public method	ImageFormatToString	Gets image format.
Public method	ImageToBytes(Image)	Converts Image to byte array.
Public method	ImageToBytes(Image, Int32)	Converts Image to byte array.
Public method Static member	IsEditableImage	Determines whether it is an editable image extension or not. Accepts extensions in both formats ".gif", and "gif"
Public method Static member	IsHtml	Determines whether it is a html/htm extension or not.
Public method Static member	IsImage	Determines whether it is an image extension or not. Accepts extensions in both formats ".gif", and "gif"
Public method Static member	IsMimeImage	Determines whether image is an image depending on mimetype.
Public method Static member	IsSupportedByImageEditor	Checks if image format is supported by Image Editor.
Public method	LoadImage	Load image data.
Public method Static member	StringToImageFormat	Gets string name of image format.
Public method Static member	UnifyFileExtension	Unifies file extensions.