OverlayImageTool Class

In This Topic

Visual tool for overlaying an image on a top of image in image viewer.

Object Model

Syntax

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration

Public Class OverlayImageTool
   Inherits RectangularSelectionTool

public class OverlayImageTool : RectangularSelectionTool

public __gc class OverlayImageTool : public RectangularSelectionTool*

public ref class OverlayImageTool : public RectangularSelectionTool^

Remarks

Image can be overlaid on a top of image in image viewer as follows:

select an image to overlay

place the mouse to the desired position

press the action button (ActionButton) and select the "overlay" region by holding the action button, release the action button

DragButton

DropButton

If ActionButton, DragButton or DropButton is set to right mouse button, context menu during action can be disabled with the DisableContextMenu property.

Example

This C#/VB.NET code shows how to programmatically overlay an image on a top of image in image viewer.

VB.NET


Class OverlayImageToolExample
    ' Programmatically overlay an image on a top of image in image viewer.
    Public Sub ProgrammaticallyOverlayImageInViewer(viewer As Vintasoft.Imaging.UI.ImageViewer)
        ' create an instance of the OverlayImageTool class
        Dim overlayImageTool1 As New Vintasoft.Imaging.UI.VisualTools.OverlayImageTool()
        ' set the tool as the current tool of the ImageViewer
        viewer.VisualTool = overlayImageTool1
        ' set an image to overlay
        overlayImageTool1.Image = New Vintasoft.Imaging.VintasoftImage("d:\image.png")
        ' set the region where image must be overlaid
        overlayImageTool1.Rectangle = New System.Drawing.Rectangle(50, 50, 250, 150)
        ' overlay an image in image viewer
        overlayImageTool1.Overlay()
    End Sub
End Class


class OverlayImageToolExample
{
    // Programmatically overlay an image on a top of image in image viewer.
    public void ProgrammaticallyOverlayImageInViewer(
        Vintasoft.Imaging.UI.ImageViewer viewer)
    {
        // create an instance of the OverlayImageTool class
        Vintasoft.Imaging.UI.VisualTools.OverlayImageTool overlayImageTool1 = 
            new Vintasoft.Imaging.UI.VisualTools.OverlayImageTool();
        // set the tool as the current tool of the ImageViewer
        viewer.VisualTool = overlayImageTool1;
        // set an image to overlay
        overlayImageTool1.Image = new Vintasoft.Imaging.VintasoftImage(@"d:\image.png");
        // set the region where image must be overlaid
        overlayImageTool1.Rectangle = new System.Drawing.Rectangle(50, 50, 250, 150);
        // overlay an image in image viewer
        overlayImageTool1.Overlay();
    }
}

Inheritance Hierarchy

System.Object
   Vintasoft.Imaging.UI.VisualTools.VisualTool
      Vintasoft.Imaging.UI.VisualTools.UserInteraction.UserInteractionVisualTool
         Vintasoft.Imaging.UI.VisualTools.RectangularSelectionTool
            Vintasoft.Imaging.UI.VisualTools.OverlayImageTool

Requirements

Target Platforms: .NET9; .NET 8; .NET 7; .NET 6; .NET Framework 4.8, 4.7, 4.6, 4.5, 4.0, 3.5

Reference

OverlayImageTool Members
Vintasoft.Imaging.UI.VisualTools Namespace

Send Feedback