OverlayMaskedDocumentCommand Class

Overlay an image using an alpha mask.

Inheritance Hierarchy

SystemObject
Atalasoft.Imaging.ImageProcessingImageCommand
Atalasoft.Imaging.ImageProcessing.DocumentOverlayMaskedDocumentCommand

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

Syntax

Copy

public class OverlayMaskedDocumentCommand : ImageCommand, 
	ISerializable

Public Class OverlayMaskedDocumentCommand
	Inherits ImageCommand
	Implements ISerializable

The OverlayMaskedDocumentCommand type exposes the following members.

Constructors

	Name	Description
	OverlayMaskedDocumentCommand	Creates a new instance of OverlayMaskedDocumentCommand.
	OverlayMaskedDocumentCommand(SerializationInfo, StreamingContext)	Creates a new instance of OverlayMaskedDocumentCommand from serialization information.
	OverlayMaskedDocumentCommand(AtalaImage, AtalaImage)	Creates a new instance of OverlayMaskedDocumentCommand specifying topImage and mask.
	OverlayMaskedDocumentCommand(AtalaImage, AtalaImage, Point)	Creates a new instance of OverlayMaskedDocumentCommand specifying topImage, mask and position.

Top

Properties

	Name	Description
	ApplyToAnyPixelFormat	Reports whether or not this command will be applied to any supplied PixelFormat image (Inherited from ImageCommand.)
	CanApplyToAnyPixelFormat	Returns true if the command can be applied to any PixelFormat. (Inherited from ImageCommand.)
	InPlaceProcessing	Gets a value indicating if the image is processed in place instead of generating a new image. (Overrides ImageCommandInPlaceProcessing.)
	Mask	Gets or sets the 1-bit image indicating the transparent and opaque regions of the overlay.
	Position	Gets or sets the position of the top image on the bottom image.
	Progress	Gets or sets the ProgressEventHandler delegate which can be used to view or cancel the progress of the current process. (Inherited from ImageCommand.)
	SupportedPixelFormats	Returns an array of PixelFormats supported by this command. (Overrides ImageCommandSupportedPixelFormats.)
	TopImage	Gets or sets the top 1-bit image to overlay.

Top

Methods

	Name	Description
	Apply	Apply the command to the given image. (Inherited from ImageCommand.)
	ApplyToImage	Obsolete. Applies the command to the source AtalaImage. (Inherited from ImageCommand.)
	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. (Inherited from ImageCommand.)
	ConstructFinalImage	Called by the default implementation of Apply, ConstructFinalImage constructs the image that will be used as the destination image for the command. (Inherited from ImageCommand.)
	ConstructImageResults	Constructs the results object for this command. (Inherited from ImageCommand.)
	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. (Inherited from ImageCommand.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetObjectData
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ImageCommandGetObjectData	Aggregates ImageCommand data into the supplied SerializationInfo object. (Inherited from ImageCommand.)
	IsPixelFormatSupported	Returns a value indicating if the specified pixel format is supported. (Inherited from ImageCommand.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	PerformActualCommand	Performs the actual command. (Overrides ImageCommandPerformActualCommand(AtalaImage, AtalaImage, Rectangle, ImageResults).)
	SelectBestAlternatePixelFormat	Choose the best pixel format to use for this command when the supplied source image's pixel format is unacceptable. (Inherited from ImageCommand.)
	SelectPreferredPixelFormat	Chooses a pixel format that is preferred for this command. (Inherited from ImageCommand.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	VerifyImage	Verify the integrity of an AtalaImage. (Inherited from ImageCommand.)
	VerifyProperties	Verify the integrity of properties in the command before processing an image. (Overrides ImageCommandVerifyProperties(AtalaImage).)

Top

Reference

Atalasoft.Imaging.ImageProcessing.Document Namespace