ImageCommand Class

Represents the base class for all image processing routines that modify image data.

Inheritance Hierarchy

System.Object
Atalasoft.Imaging.ImageProcessing.ImageCommand
More...

Namespace: Atalasoft.Imaging.ImageProcessing
Assembly: Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

Copy

public abstract class ImageCommand

Public MustInherit Class ImageCommand

The ImageCommand type exposes the following members.

Constructors

	Name	Description
	ImageCommand()	Initializes a new instance of the ImageCommand class.
	ImageCommand(SerializationInfo, StreamingContext)	Initializes a new instance of the ImageCommand class.

Top

Properties

	Name	Description
	ApplyToAnyPixelFormat	Reports whether or not this command will be applied to any supplied PixelFormat image
	CanApplyToAnyPixelFormat	Returns true if the command can be applied to any PixelFormat.
	GlobalAutoThread	Determines if all ImageCommands that support multithreaded processing will be multithreaded.
	InPlaceProcessing	Gets a value indicating if the source image data is processed in-place as opposed to returning a new image.
	Progress	Gets or sets the ProgressEventHandler delegate which can be used to view or cancel the progress of the current process.
	SupportedPixelFormats	Gets an array of supported pixel formats.

Top

Methods

	Name	Description
	AllocatePixelFormatArray	Allocate an array of PixelFormat enums.
	Apply	Apply the command to the given image.
	ApplyToImage	Obsolete. Applies the command to the source AtalaImage.
	ConstructChangedSourceImage	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.
	ConstructFinalImage	Called by the default implementation of Apply, ConstructFinalImage constructs the image that will be used as the destination image for the command.
	ConstructImageResults	Constructs the results object for this command.
	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.)
	GetChangedPixelFormat	This method is called to change the pixel format of the source image.
	GetContinuousFormatImage	A utility method for determining the best matching continuous tone pixel format and converting the given image to that format.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ImageCommandGetObjectData	Aggregates ImageCommand data into the supplied SerializationInfo object.
	IsPixelFormatSupported	Returns a value indicating if the specified pixel format is supported.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	PerformActualCommand	PerformActualCommand does the actual work of the image processing command.
	ProxyConstructChangedSourceImage	Calls the ConstructChangedSourceImage method on the supplied ImageCommand.
	ProxyConstructFinalImage
	ProxyConstructImageResults
	ProxyGetChangedPixelFormat
	ProxySelectBestAlternatePixelFormat
	ProxySelectPreferredPixelFormat
	ProxyVerifyProperties
	SelectBestAlternatePixelFormat	Choose the best pixel format to use for this command when the supplied source image's pixel format is unacceptable.
	SelectPreferredPixelFormat	Chooses a pixel format that is preferred for this command.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	VerifyImage	Verify the integrity of an AtalaImage.
	VerifyProperties	Verify the integrity of properties in the command before processing an image.

Top

Remarks

An ImageCommand can be used to apply any type of effect onto an existing image. The Apply method can be used to process the command. Classes that inherit ImageCommand can be used in the ApplyCommand method in the Workspace.

See Extending ImageCommands for more information on creating custom commands.

Remarks

Reference

Atalasoft.Imaging.ImageProcessing Namespace

Extending ImageCommands

Inheritance Hierarchy