Package ImageResizer

Namespaces
package	Caching
package	Collections
package	Configuration
package	Encoding
package	ExtensionMethods
package	Licensing
package	Plugins
package	Resizing
package	Util

Classes
class	BoxEdges
	Represents the widths of edges of a box. More...
class	ResizerSection
	Handles reading the <resizer> section from Web.Config More...
class	ImageBuilder
	Provides methods for generating resized images, and for reading and writing them to disk. Use ImageBuilder.Current to get the current instance (as configured in the application configuration), or use ImageBuilder.Current.Create() to control which extensions are used. More...
class	ImageJob
class	ImageProcessingException
	Represents an non-recoverable exception that occured while processing the image. Possible causes are: a corrupted source file, cache resource timeout (such as a locked file in imagecache), unusable configuration (for example, no registered encoders or caches), invalid syntax, or a size limit was exceeded and the request was stopped by the SizeLimiting extension. May also be caused by a missing source file/resource, in the form of the ImageMissingException subclass. More...
class	ImageCorruptedException
	A source file was corrupted More...
class	ImageMissingException
	One or more source files was missing More...
class	Instructions
	A name/value collection of image processsing instructions. The successor to ResizeSettings. Just because a key doesn't have a property wrapper doesn't mean you can't use it. i["key"] = value; isnt' that scary. More...
class	InterceptModule
	Monitors incoming image requests to determine if resizing (or other processing) is being requested. More...
class	ResizeSettings
	Represents the settings which will be used to process the image. Extends NameValueCollection to provide friendly property names for commonly used settings. Replaced by the Instructions class. Will be removed in V4.0 More...
class	ImageUploadHelperS3Extensions
class	ImageUploadHelper

Enumerations
enum	OutputFormat { OutputFormat.Jpeg = 8, OutputFormat.Png = 16, OutputFormat.Gif = 32 }
	Output image formats More...
enum	ServerCacheMode { ServerCacheMode.No, ServerCacheMode.Always, ServerCacheMode.Default }
	When to disk cache the image More...
enum	ProcessWhen { ProcessWhen.No, ProcessWhen.Always, ProcessWhen.Default }
	When to process and re-encode the file. More...
enum	ScaleMode { ScaleMode.DownscaleOnly, ScaleMode.UpscaleOnly, ScaleMode.Both, ScaleMode.UpscaleCanvas }
	Controls whether the image is allowed to upscale, downscale, both, or if only the canvas gets to be upscaled. More...
enum	StretchMode { StretchMode.Proportionally, StretchMode.Fill }
	[Deprecated (Use FitMode.Stretch)] Previously used to force an image to be 'stretched' to match a different aspect ratio. More...
enum	FitMode {   FitMode.None, FitMode.Max, FitMode.Pad, FitMode.Crop,   FitMode.Carve, FitMode.Stretch }
	How to resolve aspect ratio differences between the requested size and the original image's size. More...
enum	CropMode { CropMode.None, CropMode.Auto, CropMode.Custom }
enum	CropUnits { CropUnits.SourcePixels, CropUnits.Custom }
enum	FlipMode { FlipMode.None = 0, FlipMode.X = 4, FlipMode.Y = 6, FlipMode.XY = 2 }
	Horizontal and vertical flipping. Convertible to System.Drawing.RotateFlipType by casting. More...
enum	AnchorLocation {   AnchorLocation.TopLeft = 1, AnchorLocation.TopCenter = 2, AnchorLocation.TopRight = 4, AnchorLocation.MiddleLeft = 16,   AnchorLocation.MiddleCenter = 32, AnchorLocation.MiddleRight = 64, AnchorLocation.BottomLeft = 256, AnchorLocation.BottomCenter = 512,   AnchorLocation.BottomRight = 1024 }
	Anchor location. Convertible to System.Drawing.ContentAlignment by casting. More...
enum	GrayscaleMode {   None = 0, GrayscaleMode.Y = 1, NTSC = 1, RY = 2,   BT709 = 3, GrayscaleMode.Flat = 4 }
	Modes of converting the image to Grayscale. GrayscaleMode.Y usually produces the best resuts More...
enum	JpegSubsamplingMode {   JpegSubsamplingMode.Default = 0, JpegSubsamplingMode.Y4Cb1Cr1 = 4, JpegSubsamplingMode.Y4Cb2Cr0 = 8, JpegSubsamplingMode.Y4Cb2Cr2 = 16,   JpegSubsamplingMode.HighestQuality =32, JpegSubsamplingMode.Y4Cb4Cr4 = 32 }
	The Jpeg subsampling mode to use. Requires FreeImageEncoder, FreeImageBuilder, WicEncoder, or WicBuilder. More...

Enumeration Type Documentation

enum ImageResizer.AnchorLocation

Anchor location. Convertible to System.Drawing.ContentAlignment by casting.

Enumerator
TopLeft	Content is vertically aligned at the top, and horizontally aligned on the left.
TopCenter	Content is vertically aligned at the top, and horizontally aligned at the center.
TopRight	Content is vertically aligned at the top, and horizontally aligned on the right.
MiddleLeft	Content is vertically aligned in the middle, and horizontally aligned onthe left.
MiddleCenter	Content is vertically aligned in the middle, and horizontally aligned at the center.
MiddleRight	Content is vertically aligned in the middle, and horizontally aligned on the right.
BottomLeft	Content is vertically aligned at the bottom, and horizontally aligned on the left.
BottomCenter	Content is vertically aligned at the bottom, and horizontally aligned at the center.
BottomRight	Content is vertically aligned at the bottom, and horizontally aligned on the right.

Definition at line 204 of file Enumerations.cs.

                               {
        /// <summary>
        /// Content is vertically aligned at the top, and horizontally aligned on the left.
        /// </summary>
        TopLeft = 1,

        /// <summary>
        /// Content is vertically aligned at the top, and horizontally aligned at the center.
        /// </summary>
        TopCenter = 2,

        /// <summary>
        /// Content is vertically aligned at the top, and horizontally aligned on the right.
        /// </summary>
        TopRight = 4,
        
        /// <summary>
        /// Content is vertically aligned in the middle, and horizontally aligned onthe left.
        /// </summary>
        MiddleLeft = 16,
        
        /// <summary>
        /// Content is vertically aligned in the middle, and horizontally aligned at the center.
        /// </summary>
        MiddleCenter = 32,

        /// <summary>
        /// Content is vertically aligned in the middle, and horizontally aligned on  the right.
        /// </summary>
        MiddleRight = 64,

        /// <summary>
        /// Content is vertically aligned at the bottom, and horizontally aligned on the left.
        /// </summary>
        BottomLeft = 256,
        
        /// <summary>
        /// Content is vertically aligned at the bottom, and horizontally aligned at  the center.
        /// </summary>
        BottomCenter = 512,

        /// <summary>
        /// Content is vertically aligned at the bottom, and horizontally aligned on the right.
        /// </summary>
        BottomRight = 1024,
    }

enum ImageResizer.CropMode

Enumerator
None	Default. No cropping - uses letterboxing if strecth=proportionally and both width and height are specified.
Auto	[Deprecated] Use Mode=Crop. Minimally crops to preserve aspect ratio if stretch=proportionally.
Custom	Crops using the custom crop rectangle. Letterboxes if stretch=proportionally and both widht and height are specified.

Definition at line 145 of file Enumerations.cs.

                         {
        /// <summary>
        /// Default. No cropping - uses letterboxing if strecth=proportionally and both width and height are specified.
        /// </summary>
        None,
        /// <summary>
        /// [Deprecated] Use Mode=Crop. Minimally crops to preserve aspect ratio if stretch=proportionally.
        /// </summary>
        [Obsolete("Use Mode=Crop instead.")]
        Auto,
        /// <summary>
        /// Crops using the custom crop rectangle. Letterboxes if stretch=proportionally and both widht and height are specified.
        /// </summary>
        Custom
    }

enum ImageResizer.CropUnits

Enumerator
SourcePixels	Indicates the crop units are pixels on the original image.
Custom	Indicates a custom range is being specified for the values. Base 0.

Definition at line 162 of file Enumerations.cs.

                          {
        /// <summary>
        /// Indicates the crop units are pixels on the original image.
        /// </summary>
        SourcePixels,
        /// <summary>
        /// Indicates a custom range is being specified for the values. Base 0.
        /// </summary>
        Custom


    }

enum ImageResizer.FitMode

How to resolve aspect ratio differences between the requested size and the original image's size.

Enumerator
None	Fit mode will be determined by other settings, such as &carve=true, &stretch=fill, and &crop=auto. If none are specified and width/height are specified , &mode=pad will be used. If maxwidth/maxheight are used, &mode=max will be used.
Max	Width and height are considered maximum values. The resulting image may be smaller to maintain its aspect ratio. The image may also be smaller if the source image is smaller
Pad	Width and height are considered exact values - padding is used if there is an aspect ratio difference. Use &anchor to override the MiddleCenter default.
Crop	Width and height are considered exact values - cropping is used if there is an aspect ratio difference. Use &anchor to override the MiddleCenter default.
Carve	Width and height are considered exact values - seam carving is used if there is an aspect ratio difference. Requires the SeamCarving plugin to be installed, otherwise behaves like 'pad'.
Stretch	Width and height are considered exact values - if there is an aspect ratio difference, the image is stretched.

Definition at line 114 of file Enumerations.cs.

                        {
        /// <summary>
        /// Fit mode will be determined by other settings, such as &amp;carve=true, &amp;stretch=fill, and &amp;crop=auto. If none are specified and width/height are specified , &amp;mode=pad will be used. If maxwidth/maxheight are used, &amp;mode=max will be used.
        /// </summary>
        None,

        /// <summary>
        /// Width and height are considered maximum values. The resulting image may be smaller to maintain its aspect ratio. The image may also be smaller if the source image is smaller
        /// </summary>
        Max,
        /// <summary>
        /// Width and height are considered exact values - padding is used if there is an aspect ratio difference. Use &amp;anchor to override the MiddleCenter default.
        /// </summary>
        Pad,
        /// <summary>
        /// Width and height are considered exact values - cropping is used if there is an aspect ratio difference. Use &amp;anchor to override the MiddleCenter default.
        /// </summary>
        Crop,
        /// <summary>
        /// Width and height are considered exact values - seam carving is used if there is an aspect ratio difference. Requires the SeamCarving plugin to be installed, otherwise behaves like 'pad'.
        /// </summary>
        Carve,
        /// <summary>
        /// Width and height are considered exact values - if there is an aspect ratio difference, the image is stretched.
        /// </summary>
        Stretch,
       

    }

enum ImageResizer.FlipMode

Horizontal and vertical flipping. Convertible to System.Drawing.RotateFlipType by casting.

Enumerator
None	No flipping
X	Flip horizontally
Y	Flip vertically (identical to 180 degree rotation)
XY	Flip horizontally and vertically

Definition at line 177 of file Enumerations.cs.

                        {
        /// <summary>
        /// No flipping
        /// </summary>
        None = 0,
        /// <summary>
        /// Flip horizontally
        /// </summary>
        [EnumString("h")]
        X = 4,
        /// <summary>
        /// Flip vertically (identical to 180 degree rotation)
        /// </summary>
        [EnumString("v")]
        Y = 6,
        /// <summary>
        /// Flip horizontally and vertically
        /// </summary>
        [EnumString("both")]
        XY = 2
    }

enum ImageResizer.GrayscaleMode

Modes of converting the image to Grayscale. GrayscaleMode.Y usually produces the best resuts

Enumerator
Y	The reccomended value. Y and NTSC are identical.
Flat	Red, green, and blue are averaged to get the grayscale image. Usually produces poor results compared to other algorithms.

Definition at line 254 of file Enumerations.cs.

                              {
        [EnumString("false")]
        None = 0,
        /// <summary>
        /// The reccomended value. Y and NTSC are identical.
        /// </summary>
        [EnumString("true")]
        Y = 1,
        
        NTSC = 1,
        RY = 2,
        BT709= 3,

        /// <summary>
        /// Red, green, and blue are averaged to get the grayscale image. Usually produces poor results compared to other algorithms.
        /// </summary>
        Flat = 4
    }

enum ImageResizer.JpegSubsamplingMode

The Jpeg subsampling mode to use. Requires FreeImageEncoder, FreeImageBuilder, WicEncoder, or WicBuilder.

Enumerator
Default	The encoder's default subsampling method will be used.
Y4Cb1Cr1	411 Subsampling - Only supported by FreeImageBuilder and FreeImageEncoder. Poor quality.
Y4Cb2Cr0	420 Subsampling - Commonly used in H262 and H264. Low quality compared to 422 and 444.
Y4Cb2Cr2	422 Subsampling - Great balance of quality and file size, commonly used in high-end video formats.
HighestQuality	444 subsampling - Highest quality, largest file size.
Y4Cb4Cr4	444 subsampling - Highest quality, largest file size.

Definition at line 275 of file Enumerations.cs.

                                    {
        /// <summary>
        /// The encoder's default subsampling method will be used.
        /// </summary>
        Default = 0,
        /// <summary>
        /// 411 Subsampling - Only supported by FreeImageBuilder and FreeImageEncoder. Poor quality.
        /// </summary>
        [EnumString("411",true)]
        Y4Cb1Cr1 = 4,
        /// <summary>
        /// 420 Subsampling - Commonly used in H262 and H264. Low quality compared to 422 and 444. 
        /// </summary>
        [EnumString("420",true)]
        Y4Cb2Cr0 = 8,
        /// <summary>
        /// 422 Subsampling - Great balance of quality and file size, commonly used in high-end video formats.
        /// </summary>
        [EnumString("422",true)]
        Y4Cb2Cr2 = 16,
        /// <summary>
        /// 444 subsampling - Highest quality, largest file size.
        /// </summary>
        [EnumString("444",true)]
        HighestQuality =32,
        /// <summary>
        /// 444 subsampling - Highest quality, largest file size.
        /// </summary>
        [EnumString("444",true)]
        Y4Cb4Cr4 = 32
    }

enum ImageResizer.OutputFormat

Output image formats

Enumerator
Jpeg	Jpeg - the best format for photographs and thumbnails
Png	The best format for transparent images and vector graphics
Gif	A really poor choice for pretty much everything except animation

Definition at line 10 of file Enumerations.cs.

                             {
        /// <summary>
        /// Jpeg - the best format for photographs and thumbnails
        /// </summary>
        [EnumString("jpg",true)]
        [EnumString("jpe")]
        [EnumString("jif")]
        [EnumString("jfif")]
        [EnumString("jfi")]
        [EnumString("exif")]
        Jpeg = 8,
        /// <summary>
        /// The best format for transparent images and vector graphics
        /// </summary>
        Png = 16,
        /// <summary>
        /// A really poor choice for pretty much everything except animation
        /// </summary>
        Gif = 32
    }

enum ImageResizer.ProcessWhen

When to process and re-encode the file.

Enumerator
No	Request no processing of the image or file (generally used with cache=always). The file contents will be used as-is.
Always	Require the file or image to be processed. Will cause non-image files to fail with an ImageCorruptedException.
Default	Default. Only files with both a supported image extension and resizing settings specified in the querystring will be processed.

Definition at line 54 of file Enumerations.cs.

                            {
        /// <summary>
        /// Request no processing of the image or file (generally used with cache=always).
        /// The file contents will be used as-is.
        /// </summary>
        No,
        /// <summary>
        /// Require the file or image to be processed. Will cause non-image files to fail with an ImageCorruptedException.
        /// </summary>
        Always,
        /// <summary>
        /// Default. Only files with both a supported image extension and resizing settings specified in the querystring will be processed.
        /// </summary>
        Default
    }

enum ImageResizer.ScaleMode

Controls whether the image is allowed to upscale, downscale, both, or if only the canvas gets to be upscaled.

Enumerator
DownscaleOnly	The default. Only downsamples images - never enlarges. If an image is smaller than 'width' and 'height', the image coordinates are used instead.
UpscaleOnly	Only upscales (zooms) images - never downsamples except to meet web.config restrictions. If an image is larger than 'width' and 'height', the image coordinates are used instead.
Both	Upscales and downscales images according to 'width' and 'height', within web.config restrictions.
UpscaleCanvas	When the image is smaller than the requested size, padding is added instead of stretching the image

Definition at line 75 of file Enumerations.cs.

                          {
        /// <summary>
        /// The default. Only downsamples images - never enlarges. If an image is smaller than 'width' and 'height', the image coordinates are used instead.
        /// </summary>
        [EnumString("down")]
        DownscaleOnly,
        /// <summary>
        /// Only upscales (zooms) images - never downsamples except to meet web.config restrictions. If an image is larger than 'width' and 'height', the image coordinates are used instead.
        /// </summary>
        [EnumString("up")]
        UpscaleOnly,
        /// <summary>
        /// Upscales and downscales images according to 'width' and 'height', within web.config restrictions.
        /// </summary>
        Both,
        /// <summary>
        /// When the image is smaller than the requested size, padding is added instead of stretching the image
        /// </summary>
        [EnumString("canvas")]
        UpscaleCanvas
    }

enum ImageResizer.ServerCacheMode

When to disk cache the image

Enumerator
No	Request no disk caching of the resulting image.
Always	Request that the resulting image always be disk cached on the server, even if no modifications are made.
Default	Default caching behavior. Modified images are disk cached, unmodified images are not.

Definition at line 36 of file Enumerations.cs.

                                {
        /// <summary>
        /// Request no disk caching of the resulting image.
        /// </summary>
        No,
        /// <summary>
        /// Request that the resulting image always be disk cached on the server, even if no modifications are made. 
        /// </summary>
        Always,
        /// <summary>
        /// Default caching behavior. Modified images are disk cached, unmodified images are not.
        /// </summary>
        Default

    }

enum ImageResizer.StretchMode

[Deprecated (Use FitMode.Stretch)] Previously used to force an image to be 'stretched' to match a different aspect ratio.

Enumerator
Proportionally	[Deprecated (Use FitMode)] Maintains aspect ratio. Default.
Fill	[Deprecated (Use FitMode)] Skews image to fit the new aspect ratio defined by 'width' and 'height'

Definition at line 101 of file Enumerations.cs.

                            {
        /// <summary>
        /// [Deprecated (Use FitMode)] Maintains aspect ratio. Default.
        /// </summary>
        Proportionally,
        /// <summary>
        /// [Deprecated (Use FitMode)] Skews image to fit the new aspect ratio defined by 'width' and 'height'
        /// </summary>
        Fill
    }