VintaSoft Imaging .NET SDK v8.6
Vintasoft.Imaging.Svg.VisualTools Namespace / WebHighlightToolJS type
In This Topic
    WebHighlightToolJS type
    In This Topic
    Visual tool that allows to highlight several image regions in the image viewer.
    Syntax
    // Parameters
    var viewer; // Type:  object
    
    var instance = new Vintasoft.Imaging.Svg.VisualTools.WebHighlightToolJS(viewer);
    function WebHighlightToolJS;
    Inheritance Hierarchy

    Object
       Vintasoft.Imaging.Svg.VisualTools.WebHighlightToolJS

    Browser Compatibility
    9
    5
    11
    5
    Constructors
     NameDescription
    public ConstructorVisual tool that allows to highlight several image regions in the image viewer.  
    Top
    Fields
     NameDescription
    public Fieldstatic (Shared in Visual Basic)  
    Top
    Methods
     NameDescription
    public MethodAdds the image regions that should be highlighted in the image viewer  
    public MethodClears all highlighted image regions from the highlight tool.  
    public MethodFinds the highlighted image region located at the specified coordinates.  
    public MethodGets the mouse button which executes the action of the visual tool.  
    public MethodGets a cursor which should be used in image viewer when visual tool executes its action.  
    public MethodGets a cursor which should be used in image viewer when visual tool is active in image viewer.  
    public MethodGets a value indicating whether image viewer must disable context menu in image viewer if the right mouse button is set as an action button of the visual tool.  
    public MethodGets a value indicating whether visual tool can respond to user interaction.  
    public MethodGets the count of mouse clicks in series of clicks.  
    public MethodGets a delay, in milliseconds, between mouse clicks in series of clicks.  
    public MethodGets the name of visual tool.  
    public MethodGets the highlighted image region which is selected in the image viewer.  
    public MethodGets a color of brush that should be used for filling the highlighted image region in the image viewer.  
    public MethodGets a color of pen that should be used for drawing the outline of the highlighted image region in the image viewer.  
    public MethodRemoves the highlighted image region from the highlight tool.  
    public MethodResets the visual tool.  
    public MethodSets the mouse button which executes the action of the visual tool.  
    public MethodSets a cursor which should be used in image viewer when visual tool executes its action.  
    public MethodSets a cursor which should be used in image viewer when visual tool is active in image viewer.  
    public MethodSets a value indicating whether image viewer must disable context menu in image viewer if the right mouse button is set as an action button of the visual tool.  
    public MethodSets a value indicating whether visual tool can respond to user interaction.  
    public MethodSets a delay, in milliseconds, between mouse clicks in series of clicks.  
    public MethodSets the highlighted image region that should be selected in the image viewer.  
    public MethodSets a color of brush that should be used for filling the highlighted image region in the image viewer.  
    public MethodSets a color of pen that should be used for drawing the outline of the highlighted image region in the image viewer.  
    Top
    Events
     NameDescription
    public EventOccurs when the visual tool initialization is failed.  
    public EventOccurs when the visual tool initialization is finished.  
    public EventOccurs when the visual tool initialization is started.  
    public EventOccurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is double clicked.  
    public EventOccurs when the mouse pointer is over the image viewer, this tool is enabled and a mouse button is pressed.  
    public EventOccurs when the mouse pointer is moved and this tool is enabled.  
    public EventOccurs when this tool is enabled and a mouse button is released.  
    Top
    See Also