Click or drag to resize

ResizeCanvasCommand Class

Overlays the current image onto a specified position on a new image of the specified background color.
Inheritance Hierarchy
SystemObject
  Atalasoft.Imaging.ImageProcessingImageCommand
    Atalasoft.Imaging.ImageProcessing.TransformsResizeCanvasCommand

Namespace:  Atalasoft.Imaging.ImageProcessing.Transforms
Assembly:  Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
[SerializableAttribute]
public class ResizeCanvasCommand : ImageCommand, 
	ISerializable

The ResizeCanvasCommand type exposes the following members.

Constructors
  NameDescription
Public methodResizeCanvasCommand
Creates a new instance of ResizeCanvasCommand.
Protected methodResizeCanvasCommand(SerializationInfo, StreamingContext)
Creates a new instance of ResizeCanvasCommand from serialization information
Public methodResizeCanvasCommand(Size, Point, Color)
Creates a new instance of ResizeCanvasCommand specifying canvasSize, position, canvasColor, and canvasPaletteIndex.
Public methodResizeCanvasCommand(Size, Point, Int32)
Creates a new instance of ResizeCanvasCommand specifying canvasSize, position, canvasColor, and canvasPaletteIndex.
Top
Properties
  NameDescription
Public propertyApplyToAnyPixelFormat
Reports whether or not this command will be applied to any supplied PixelFormat image
(Inherited from ImageCommand.)
Public propertyCanApplyToAnyPixelFormat
Returns true if the command can be applied to any PixelFormat.
(Inherited from ImageCommand.)
Public propertyCanvasColor
Gets or sets the background color of the canvas.
Public propertyCanvasPaletteIndex
Gets or sets the palette index of the canvas.
Public propertyCanvasSize
Gets or sets the size of the new canvas.
Public propertyInPlaceProcessing
Gets a value indicating if the source image data is processed in-place as opposed to returning a new image.
(Inherited from ImageCommand.)
Public propertyPosition
Gets or sets the position of the image on the new canvas.
Public propertyProgress
Gets or sets the ProgressEventHandler delegate which can be used to view or cancel the progress of the current process.
(Inherited from ImageCommand.)
Public propertySupportedPixelFormats
Returns an array of PixelFormats supported by this command.
(Overrides ImageCommandSupportedPixelFormats.)
Top
Methods
  NameDescription
Public methodApply
Apply the command to the given image.
(Inherited from ImageCommand.)
Public methodApplyToImage Obsolete.
Applies the command to the source AtalaImage.
(Inherited from ImageCommand.)
Protected methodConstructChangedSourceImage
The method is called by the default implementation of Apply. It determines if it is necessary to create a copy of the source image in a different pixel format and if so, determines the best new pixel format and allocates that image.
(Inherited from ImageCommand.)
Protected methodConstructFinalImage
Called by the default implementation of Apply, ConstructFinalImage constructs the image that will be used as the destination image for the command.
(Overrides ImageCommandConstructFinalImage(AtalaImage).)
Protected methodConstructImageResults
Constructs the results object for this command.
(Inherited from ImageCommand.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetChangedPixelFormat
This method is called to change the pixel format of the source image.
(Inherited from ImageCommand.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectData
Fills a SerializationInfo object with information about this command.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodImageCommandGetObjectData
Aggregates ImageCommand data into the supplied SerializationInfo object.
(Inherited from ImageCommand.)
Public methodIsPixelFormatSupported
Returns a value indicating if the specified pixel format is supported.
(Inherited from ImageCommand.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodPerformActualCommand
PerformActualCommand does the actual work of the image processing command.
(Overrides ImageCommandPerformActualCommand(AtalaImage, AtalaImage, Rectangle, ImageResults).)
Protected methodSelectBestAlternatePixelFormat
Choose the best pixel format to use for this command when the supplied source image's pixel format is unacceptable.
(Inherited from ImageCommand.)
Protected methodSelectPreferredPixelFormat
Chooses a pixel format that is preferred for this command.
(Overrides ImageCommandSelectPreferredPixelFormat(AtalaImage, PixelFormat, PixelFormat).)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodVerifyImage
Verify the integrity of an AtalaImage.
(Inherited from ImageCommand.)
Protected methodVerifyProperties
Verify the integrity of properties in the command before processing an image.
(Overrides ImageCommandVerifyProperties(AtalaImage).)
Top
Remarks

This command can be used for adding a border to an image.

This method requires a continuous tone image. If the source image is not continuous, it will raise the ChangePixelFormat event and convert the image to a continuous tone format, which can be 8-bit grayscale, RGB, or RGBA.

Examples
ResizeCanvas Example (C#)
// Load a 24-bit image.
AtalaImage image = new AtalaImage(@"D:\Test Images\1.jpg");

// Add a 40 pixel border around the image.
Size newSize = new Size(image.Width + 80, image.Height + 80);

// We position the image at 39, 39 because the top, left position is 0, 0.
ResizeCanvasCommand cmd = new ResizeCanvasCommand(newSize, new Point(39, 39), Color.White);
AtalaImage result = cmd.Apply(image).Image;

image.Dispose();
ResizeCanvas Example (Visual Basic)
' Load a 24-bit image.
Dim image As AtalaImage =  New AtalaImage("D:\Test Images\1.jpg") 

' Add a 40 pixel border around the image.
Dim NewSize As Size =  New Size(image.Width + 80,image.Height + 80) 

' We position the image at 39, 39 because the top, left position is 0, 0.
Dim cmd As ResizeCanvasCommand =  New ResizeCanvasCommand(NewSize,New Point(39,39),Color.White) 
Dim result As AtalaImage =  cmd.Apply(image).Image

image.Dispose()
See Also