ImageHelper Members

Kentico 8.0 API Reference

The ImageHelper type exposes the following members.

Constructors

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

Methods

	Name	Description
	CanResizeImage	Indicates if current image can be resized to the specified dimensions.
	EnsureImageDimensions(Int32, Int32, Int32)	Returns new image dimensions (int[2]: 0 - width, 1 - height) .
	EnsureImageDimensions(Int32, Int32, Int32, Int32, Int32)	Computes new image dimensions according to the specified parameters, and returns it.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAutoResizeDimensions	Gets dimensions from settings into width, height and max side size parameters.
	GetAutoResizeToHeight	Returns HEIGHT the images should be automatically resized to. Value is returned from the site settings.
	GetAutoResizeToMaxSideSize	Returns MAX SIDE SIZE the images should be automatically resized to. Value is returned from the site settings.
	GetAutoResizeToWidth	Returns WIDTH the images should be automatically resized to. Value is returned from the site settings.
	GetBytes	Gets the binary data for the given image
	GetConvertedImage	Transforms image to different format.
	GetConvertedImageData	Transforms image to different format.
	GetFlippedImage	Flips image.
	GetFlippedImageData	Flips image.
	GetGrayscaledImage	Transforms image to grayscale.
	GetGrayscaledImageData	Transforms image to grayscale.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetImage	Gets the image based on the file name.
	GetImageThumbnailFileName	Returns image thumbnail file name.
	GetImageWithWatermarkData	Gets the image.
	GetPositionEnum	Gets the enumeration of the given position string.
	GetQRCodeUrl(String, Int32)	Gets the URL for the given QR code
	GetQRCodeUrl(String, Int32, String, Int32, String, Int32, String, String)	Gets the URL for the given QR code
	GetResizedImage(Int32)	Returns resized image according to max side size.
	GetResizedImage(Int32, Int32)	Returns resized image.
	GetResizedImageData(Int32, Int32)	Returns resized image as the data array. For quality is used DefaultQuality.
	GetResizedImageData(Int32, Int32, Int32)	Returns resized image as the data array.
	GetResizedImageData(HttpPostedFile, 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.
	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.
	GetResizeEnum	Returns image resize enumeration for given string.
	GetRotatedImage	Rotates image by specified angle.
	GetRotatedImageData	Rotates image by specified angle.
	GetTrimmedImage(Int32, Int32, ImageHelper ImageTrimAreaEnum)	Trim image by specified area.
	GetTrimmedImage(Int32, Int32, Int32, Int32)	Trim image by specified area.
	GetTrimmedImageData(Int32, Int32, ImageHelper ImageTrimAreaEnum)	Trim image by specified area.
	GetTrimmedImageData(Int32, Int32, Int32, Int32)	Crop image by specified area.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ImageFormatToString	Gets image format.
	ImageToBytes(Image)	Converts Image to byte array.
	ImageToBytes(Image, Int32)	Converts Image to byte array.
	IsFlash	Obsolete. Determines whether it is a flash extension or not.
	IsHtml	Determines whether it is a html/htm extension or not.
	IsImage	Determines whether it is an image extension or not. Accepts extensions in both formats ".gif", and "gif"
	IsMimeImage	Determines whether image is an image depending on mimetype.
	IsSupportedByImageEditor	Checks if image format is supported by Image Editor.
	LoadImage	Load image data.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	StringToImageFormat	Gets string name of image format.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UnifyFileExtension	Unifies file extensions.

Extension Methods

	Name	Description
	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

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