VintaSoft Imaging .NET SDK v8.6
Vintasoft.Imaging.ImageProcessing Namespace / OverlayCommand Class
Members Example



In This Topic
    OverlayCommand Class
    In This Topic
    Overlays image on a top of the another image.
    Object Model
    OverlayCommand ClassVintasoftImage ClassRegionOfInterest ClassProcessingCommandResults ClassProcessingCommandResult Class
    Syntax
    'Declaration
     
    Public Class OverlayCommand 
       Inherits ProcessingCommandWithRegion
    public class OverlayCommand : ProcessingCommandWithRegion 
    public __gc class OverlayCommand : public ProcessingCommandWithRegion 
    public ref class OverlayCommand : public ProcessingCommandWithRegion 
    Remarks
    The top image will be always converted to the pixel format of the bottom image.
    Palette of the bottom image will be used if bottom image is a palette image.

    This command can overlay 8- and 32-bpp images with transparency, transparency of alpha component in the overlay image is used.
    This command can overlay 24- and 32-bpp images with transparency, color, in overlay image, specified as transparent color is used.
    Example
    This example shows how to load image from disk, overlay the image by another image and save the result to a new image file.
    Class OverlayCommandExample
        Public Sub ProcessImage()
            ' [ do not forget to set your image file path here! ]
            ' open an existing image
            Dim image As New Vintasoft.Imaging.VintasoftImage("Flower.jpg")
                
            Dim overlayImage As New Vintasoft.Imaging.VintasoftImage("Background.jpg")
                
            ' create the command
            Dim command As New Vintasoft.Imaging.ImageProcessing.OverlayCommand(overlayImage, New System.Drawing.Point(200, 200))
            ' subscribe to progress event
            AddHandler command.Progress, New System.EventHandler(Of Vintasoft.Imaging.ImageProcessing.ImageProcessingProgressEventArgs)(AddressOf command_Progress)
                
            Try
                ' execute the command
                command.ExecuteInPlace(image)
            Catch ex As Vintasoft.Imaging.ImageProcessing.ImageProcessingException
                ' show error message if problem occured
                System.Windows.Forms.MessageBox.Show(ex.Message)
                Return
            End Try
                
            ' save the processed image to the new file
            image.Save("processed-image.tif")
        End Sub
                
        Private Sub command_Progress(sender As Object, e As Vintasoft.Imaging.ImageProcessing.ImageProcessingProgressEventArgs)
            ' update progress info using e.Progress property
            ' ...
                
            ' cancel execution of command using e.Cancel property if necessary
            ' ...
        End Sub
    End Class
    class OverlayCommandExample
    {
        public void ProcessImage()
        {
            // [ do not forget to set your image file path here! ]
            // open an existing image
            Vintasoft.Imaging.VintasoftImage image = new Vintasoft.Imaging.VintasoftImage("Flower.jpg");
                
            Vintasoft.Imaging.VintasoftImage overlayImage = new Vintasoft.Imaging.VintasoftImage("Background.jpg");
                
            // create the command
            Vintasoft.Imaging.ImageProcessing.OverlayCommand command =
                new Vintasoft.Imaging.ImageProcessing.OverlayCommand(overlayImage, new System.Drawing.Point(200, 200));
            // subscribe to progress event
            command.Progress +=
                new System.EventHandler<Vintasoft.Imaging.ImageProcessing.ImageProcessingProgressEventArgs>(command_Progress);
                
            try
            {
                // execute the command
                command.ExecuteInPlace(image);
            }
            catch (Vintasoft.Imaging.ImageProcessing.ImageProcessingException ex)
            {
                // show error message if problem occured
                System.Windows.Forms.MessageBox.Show(ex.Message);
                return;
            }
                
            // save the processed image to the new file
            image.Save("processed-image.tif");
        }
                
        void command_Progress(object sender, Vintasoft.Imaging.ImageProcessing.ImageProcessingProgressEventArgs e)
        {
            // update progress info using e.Progress property
            // ...
                
            // cancel execution of command using e.Cancel property if necessary
            // ...
        }
    }
    Inheritance Hierarchy
    Requirements

    Target Platforms: Windows 10, Windows 8, Windows 7, Windows Vista, Windows XP, Windows Server 2012, Windows Server 2008, Windows Server 2003

    See Also