 |
ImageResizer
3.4.0
|
|
ImageResizer
3.4.0
|
Provides extensibility points for drawing watermarks and even modifying resizing/image settings More...
Public Member Functions | |
| IPlugin | Install (Configuration.Config c) |
| bool | Uninstall (Configuration.Config c) |
| IEnumerable< string > | GetSupportedQuerystringKeys () |
| If the plugin reads any values from the querystring, the names of the keys should be specified here. This information is required so that the HttpModule knows when to handle an image request. More... | |
 Public Member Functions inherited from ImageResizer.Plugins.Watermark.LegacyWatermarkFeatures | |
| Bitmap | GetMemCachedBitmap (string virtualPath) |
| Loads a bitmap, cached using asp.net's cache More... | |
| Public Member Functions inherited from ImageResizer.Resizing.AbstractImageProcessor | |
| AbstractImageProcessor () | |
| Creates a new AbstractImageProcessor with no extensions More... | |
| AbstractImageProcessor (IEnumerable< BuilderExtension > extensions) | |
| Creates a new AbstractImageProcessor which will run the specified extensions with each method call. More... | |
| virtual Bitmap | DecodeStreamFailed (Stream s, ResizeSettings settings, string optionalPath) |
| Extensions are executed until one extension returns a non-null value. This is taken to mean that the error has been resolved. Extensions should not throw an exception unless they wish to cause subsequent extensions to not execute. If extensions throw an ArgumentException or ExternalException, it will be wrapped in an ImageCorruptedException instance. If the Bitmap class is used for decoding, read gdi-bugs.txt and make sure you set b.Tag to new BitmapTag(optionalPath,stream); More... | |
| virtual Bitmap | DecodeStream (Stream s, ResizeSettings settings, string optionalPath) |
| Extend this to support alternate image source formats. If the Bitmap class is used for decoding, read gdi-bugs.txt and make sure you set b.Tag to new BitmapTag(optionalPath,stream); More... | |
| Public Member Functions inherited from ImageResizer.Plugins.IPlugin | |
| IPlugin | Install (Config c) |
| Installs the plugin in the specified Config instance. The plugin must handle all the work of loading settings, registering the plugin etc. More... | |
| bool | Uninstall (Config c) |
| Uninstalls the plugin. Should reverse all changes made during Install More... | |
Protected Member Functions | |
|
Dictionary< string, IEnumerable< Layer > > | ParseWatermarks (Node n, ref ImageLayer otherImageDefaults) |
| RequestedAction | RenderLayersForLevel (ImageState s, Layer.LayerPlacement only) |
| override RequestedAction | PostRenderBackground (ImageState s) |
| Process.5(Render).2 After the background color is rendered More... | |
| override RequestedAction | RenderOverlays (ImageState s) |
| Process.5(Render).15: Watermarks can be rendered here. All image processing should be done More... | |
| Protected Member Functions inherited from ImageResizer.Plugins.Watermark.LegacyWatermarkFeatures | |
| bool | LegacyDrawWatermark (ImageState s) |
| Protected Member Functions inherited from ImageResizer.Resizing.AbstractImageProcessor | |
| virtual void | PreLoadImage (ref object source, ref string path, ref bool disposeSource, ref ResizeSettings settings) |
| Extend this to allow additional types of source objects to be accepted by transforming them into Bitmap instances. More... | |
| virtual Stream | GetStream (object source, ResizeSettings settings, ref bool disposeStream, out string path, out bool restoreStreamPosition) |
| Extend this to allow additional types of source objects to be accepted by transforming them into Stream instances. First plugin to return a Stream wins. More... | |
| virtual RequestedAction | PostDecodeStream (ref Bitmap img, ResizeSettings settings) |
| Extend this to modify the Bitmap instance after it has been decoded by DecodeStream or DecodeStreamFailed More... | |
| virtual void | PreAcquireStream (ref object dest, ResizeSettings settings) |
| Extend this to allow additional types of destination objects to be accepted by transforming them into a stream. More... | |
| virtual RequestedAction | BuildJob (ImageResizer.ImageJob job) |
| The method to override if you want to replace the entire pipeline. All Build() calls call this method first. Does nothing in ImageBuilder More... | |
| virtual RequestedAction | buildToStream (Bitmap source, Stream dest, ResizeSettings settings) |
| Called for Build() calls that want the result encoded. (Not for Bitmap Build(source,settings) calls. Only override this method if you need to replace the behavior of image encoding and image processing together, such as adding support for resizing multi-page TIFF files or animated GIFs. More... | |
| virtual Bitmap | buildToBitmap (Bitmap source, ResizeSettings settings, bool transparencySupported) |
| Most calls funnel through here. Default behavior configures an ImageState instance and calls Process(imageState); Shouldn't be overriden for any reason I can think of - use the appropriate virtual method under Process(). If an extension returns a Bitmap instance, it will be used instead of the default behavior. Does NOT dispose of 'source' or 'source's underlying stream. More... | |
| virtual RequestedAction | OnProcess (ImageState s) |
| Process.0 First step of the Process() method. Can replace the entire Process method if RequestAction.Cancel is returned. Can be used to add points to translate (for image maps), and also to modify the settings More... | |
| virtual RequestedAction | PrepareSourceBitmap (ImageState s) |
| Process.1 Switches the bitmap to the correct frame or page, and applies source flipping commands. More... | |
| virtual RequestedAction | PostPrepareSourceBitmap (ImageState s) |
| Process.2 Extend this to apply any pre-processing to the source bitmap that needs to occur before Layout begins More... | |
| virtual RequestedAction | Layout (ImageState s) |
| Process.3(Layout).0: This is the last point at which points to translate should be added. Only return RequestedAction.Cancel if you wish to replace the entire Layout sequence logic. More... | |
| virtual RequestedAction | FlipExistingPoints (ImageState s) |
| Process.3(Layout).1: This is where the points in the layout are flipped the same way the source bitmap was flipped (unless their flags specify otherwise) More... | |
| virtual RequestedAction | LayoutImage (ImageState s) |
| Process.3(Layout).2: Rings 'image' and 'imageArea' are added to the layout. More... | |
| virtual RequestedAction | PostLayoutImage (ImageState s) |
| Process.3(Layout).3: Add rings here to insert them between the image area and the padding More... | |
| virtual RequestedAction | LayoutPadding (ImageState s) |
| Process.3(Layout).4: Ring "padding" is added to the layout More... | |
| virtual RequestedAction | PostLayoutPadding (ImageState s) |
| Process.3(Layout).5: Add rings here to insert them between the padding and the border More... | |
| virtual RequestedAction | LayoutBorder (ImageState s) |
| Process.3(Layout).6: Ring "border" is added to the layout More... | |
| virtual RequestedAction | PostLayoutBorder (ImageState s) |
| Process.3(Layout).7: Add rings here to insert them between the border and the effect rings More... | |
| virtual RequestedAction | LayoutEffects (ImageState s) |
| Process.3(Layout).8: Effects such as 'shadow' are added here. More... | |
| virtual RequestedAction | PostLayoutEffects (ImageState s) |
| Process.3(Layout).9: Add rings here to insert them between the effects and the margin More... | |
| virtual RequestedAction | LayoutMargin (ImageState s) |
| Process.3(Layout).10: Margins are added to the layout More... | |
| virtual RequestedAction | PostLayoutMargin (ImageState s) |
| Process.3(Layout).11: Add rings here to insert them around the margin. Rings will be outermost More... | |
| virtual RequestedAction | LayoutRotate (ImageState s) |
| Process.3(Layout).anytime: Occurs when the layout is rotated. May be called anytime during Layout() More... | |
| virtual RequestedAction | PostLayoutRotate (ImageState s) |
| Process.3(Layout).anytime: Occurs after the layout is rotated. May be called anytime during Layout() More... | |
| virtual RequestedAction | LayoutNormalize (ImageState s) |
| Process.3(Layout).anytime: Occurs when the layout is normalized to 0,0. May be called anytime during Layout() More... | |
| virtual RequestedAction | PostLayoutNormalize (ImageState s) |
| Process.3(Layout).anytime: Occurs after the layout is normalized. May be called anytime during Layout() More... | |
| virtual RequestedAction | LayoutRound (ImageState s) |
| Process.3(Layout).anytime: Occurs when the layout point values are rounded to integers. May be called anytime during Layout() More... | |
| virtual RequestedAction | PostLayoutRound (ImageState s) |
| Process.3(Layout).anytime: Occurs after the layout point values are rounded to integers. May be called anytime during Layout() More... | |
| virtual RequestedAction | EndLayout (ImageState s) |
| Process.3(Layout).12: Occurs once layout has finished. No more changes should occur to points or rings in the layout after this method. destSize is calculated here. More... | |
| virtual RequestedAction | PrepareDestinationBitmap (ImageState s) |
| Process.4: The destination bitmap is created and sized based destSize. A graphics object is initialized for rendering. More... | |
| virtual RequestedAction | Render (ImageState s) |
| Process.5(Render) Rendering. Do not return RequestedAction.Cancel unless you want to replace the entire rendering system. More... | |
| virtual RequestedAction | RenderBackground (ImageState s) |
| Process.5(Render).1 The background color is rendered More... | |
| virtual RequestedAction | RenderEffects (ImageState s) |
| Process.5(Render).3 Effects (such as a drop shadow or outer glow) are rendered More... | |
| virtual RequestedAction | PostRenderEffects (ImageState s) |
| Process.5(Render).4 After outer effects are rendered More... | |
| virtual RequestedAction | RenderPadding (ImageState s) |
| Process.5(Render).5 Image padding is drawn More... | |
| virtual RequestedAction | PostRenderPadding (ImageState s) |
| Process.5(Render).6 After image padding is drawn More... | |
| virtual RequestedAction | CreateImageAttribues (ImageState s) |
| Process.5(Render).7: An ImageAttributes instance is created if it doesn't already exist. More... | |
| virtual RequestedAction | PostCreateImageAttributes (ImageState s) |
| Process.5(Render).8: The ImageAttributes instance exists and can be modified or replaced. More... | |
| virtual RequestedAction | PreRenderImage (ImageState s) |
| Process.5(Render).9: Plugins have a chance to pre-process the source image before it gets rendered, and save it to s.preRenderBitmap More... | |
| virtual RequestedAction | RenderImage (ImageState s) |
| Process.5(Render).10: The image is copied to the destination parallelogram specified by ring 'image'. More... | |
| virtual RequestedAction | PostRenderImage (ImageState s) |
| Process.5(Render).11: After the image is drawn More... | |
| virtual RequestedAction | RenderBorder (ImageState s) |
| Process.5(Render).12: The border is rendered More... | |
| virtual RequestedAction | PostRenderBorder (ImageState s) |
| Process.5(Render).13: After the border is drawn More... | |
| virtual RequestedAction | PreRenderOverlays (ImageState s) |
| Process.5(Render).14: Any last-minute changes before watermarking or overlays are applied More... | |
| virtual RequestedAction | PreFlushChanges (ImageState s) |
| Process.5(Render).16: Called before changes are flushed and the graphics object is destroyed. More... | |
| virtual RequestedAction | FlushChanges (ImageState s) |
| Process.5(Render).17: Changes are flushed to the bitmap here and the graphics object is destroyed. More... | |
| virtual RequestedAction | PostFlushChanges (ImageState s) |
| Process.5(Render).18: Changes have been flushed to the bitmap, but the final bitmap has not been flipped yet. More... | |
| virtual RequestedAction | ProcessFinalBitmap (ImageState s) |
| Process.6: Non-rendering changes to the bitmap object occur here, such as flipping. The graphics object is unavailable. More... | |
| virtual RequestedAction | EndProcess (ImageState s) |
| Process.7: Layout and rendering are both complete. More... | |
Protected Attributes | |
|
Dictionary< string, IEnumerable< Layer > > | _namedWatermarks = null |
| Protected Attributes inherited from ImageResizer.Plugins.Watermark.LegacyWatermarkFeatures | |
| Config | c |
| Protected Attributes inherited from ImageResizer.Resizing.AbstractImageProcessor | |
| volatile IEnumerable < BuilderExtension > | exts |
| Contains the set of extensions that are called for every method. More... | |
Properties | |
| ImageLayer | OtherImages [get, set] |
| When a &watermark command does not specify a named preset, it is assumed to be a file name. Set OtherImages.Path to the search folder. All watermark images (except for presets) must be in the root of the search folder. The remainder of the settings affect how each watermrak will be positioned and displayed. More... | |
| Dictionary< string, IEnumerable< Layer > > | NamedWatermarks [get, set] |
| This dictionary contains watermarks keyed by name. Values are enumerations of layers - a watermark can have multiple layers. More... | |
Additional Inherited Members | |
| Public Attributes inherited from ImageResizer.Plugins.Watermark.LegacyWatermarkFeatures | |
| string | watermarkDir = null |
| SizeF | watermarkSize = new SizeF(1, 1) |
| Boolean | valuesPercentages = true |
| Boolean | keepAspectRatio = true |
| SizeF | topLeftPadding = new SizeF(0, 0) |
| SizeF | bottomRightPadding = new SizeF(0, 0) |
| Boolean | hideIfTooSmall = false |
| System.Drawing.ContentAlignment | align = ContentAlignment.MiddleCenter |
Provides extensibility points for drawing watermarks and even modifying resizing/image settings
Definition at line 21 of file Watermark.cs.
|
inline |
If the plugin reads any values from the querystring, the names of the keys should be specified here. This information is required so that the HttpModule knows when to handle an image request.
Implements ImageResizer.Plugins.IQuerystringPlugin.
Definition at line 59 of file Watermark.cs.
|
inlineprotectedvirtual |
Process.5(Render).2 After the background color is rendered
| s |
Reimplemented from ImageResizer.Resizing.AbstractImageProcessor.
Definition at line 183 of file Watermark.cs.
|
inlineprotectedvirtual |
Process.5(Render).15: Watermarks can be rendered here. All image processing should be done
| s |
Reimplemented from ImageResizer.Resizing.AbstractImageProcessor.
Definition at line 187 of file Watermark.cs.
|
getset |
This dictionary contains watermarks keyed by name. Values are enumerations of layers - a watermark can have multiple layers.
Definition at line 40 of file Watermark.cs.
|
getset |
When a &watermark command does not specify a named preset, it is assumed to be a file name. Set OtherImages.Path to the search folder. All watermark images (except for presets) must be in the root of the search folder. The remainder of the settings affect how each watermrak will be positioned and displayed.
Definition at line 32 of file Watermark.cs.
1.8.5
