Mouse Class

  • Article

Provides static methods for performing mouse actions in a user interface (UI) test.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.TestTools.UITesting.Mouse

Namespace:  Microsoft.VisualStudio.TestTools.UITesting
Assembly:  Microsoft.VisualStudio.TestTools.UITesting (in Microsoft.VisualStudio.TestTools.UITesting.dll)

Syntax

'Declaration
Public Class Mouse _
    Implements IDisposable

public class Mouse : IDisposable

public ref class Mouse : IDisposable

type Mouse =  
    class
        interface IDisposable
    end

public class Mouse implements IDisposable

The Mouse type exposes the following members.

Constructors

  Name Description
Protected method Mouse Infrastructure. Initializes a new instance of the Mouse class.

Top

Properties

  Name Description
Public propertyStatic member HoverDuration Gets or sets the mouse hover duration in milliseconds.
Public propertyStatic member Instance Gets or sets the Mouse instance.
Public propertyStatic member Location Gets or sets the location of the Mouse.
Protected property LocationImplementation Gets or sets the current location of the Mouse.
Public propertyStatic member MouseDragSpeed Gets or sets the mouse move speed.
Public propertyStatic member MouseMoveSpeed Gets or sets the mouse move speed.

Top

Methods

  Name Description
Public methodStatic member Click() Clicks the default mouse button.
Public methodStatic member Click(Point) Clicks the default mouse button at the specified location.
Public methodStatic member Click(MouseButtons) Clicks the specified mouse button.
Public methodStatic member Click(ModifierKeys) Clicks the default mouse button while holding the specified modifier keys.
Public methodStatic member Click(UITestControl) Clicks the default mouse button on the specified control.
Public methodStatic member Click(UITestControl, Point) Clicks the default mouse button on the specified control at the specified location relative to that control.
Public methodStatic member Click(UITestControl, MouseButtons) Clicks the specified mouse button on the specified control.
Public methodStatic member Click(UITestControl, ModifierKeys) Clicks the default mouse button on the specified control while holding the specified modifier keys.
Public methodStatic member Click(MouseButtons, ModifierKeys, Point) Clicks the specified mouse button while holding the specified modifier keys at the specified location.
Public methodStatic member Click(UITestControl, MouseButtons, ModifierKeys, Point) Clicks the specified mouse button on the specified control while holding the specified modifier keys at the specified location relative to that control.
Protected method ClickImplementation Clicks the specified mouse button on the specified control while holding the specified modifier keys at the specified location that is relative to that control.
Public method Dispose() Releases all resources that are used by the current instance of the Mouse class.
Protected method Dispose(Boolean) Cleans up any resources that are used.
Public methodStatic member DoubleClick() Double-clicks the mouse button.
Public methodStatic member DoubleClick(Point) Double-clicks the default mouse button at the specified location.
Public methodStatic member DoubleClick(MouseButtons) Double-clicks the specified mouse button.
Public methodStatic member DoubleClick(ModifierKeys) Double-clicks the default mouse button that has modifiers.
Public methodStatic member DoubleClick(UITestControl) Double-clicks the default mouse button on the specified control.
Public methodStatic member DoubleClick(UITestControl, Point) Double-clicks the default mouse button on the specified control at the specified location that is relative to the control.
Public methodStatic member DoubleClick(UITestControl, MouseButtons) Double-clicks the specified mouse button on the specified control.
Public methodStatic member DoubleClick(UITestControl, ModifierKeys) Double-clicks the default mouse button on the control with modifiers.
Public methodStatic member DoubleClick(MouseButtons, ModifierKeys, Point) Double-clicks the specified mouse button while holding the specified modifier keys at the specified screen location.
Public methodStatic member DoubleClick(UITestControl, MouseButtons, ModifierKeys, Point) Double-clicks the specified mouse button on the specified control while holding the specified modifier keys at the specified location that is relative to that control.
Protected method DoubleClickImplementation Double-clicks the specified mouse button on the specified control while holding the specified modifier keys at the specified location that is relative to that control.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize The finalizer method. (Overrides Object.Finalize().)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public methodStatic member Hover(Point) Moves the mouse to the specified location.
Public methodStatic member Hover(UITestControl) Pauses the mouse on the specified control.
Public methodStatic member Hover(Point, Int32) Pause the mouse at the specified point for a specified duration.
Public methodStatic member Hover(UITestControl, Point) Moves the mouse to the specified location that is relative to the specified control.
Public methodStatic member Hover(UITestControl, Point, Int32) Pauses the mouse at the specified location that is relative to the specified control for a specified duration.
Protected method HoverImplementation Pauses the mouse at the specified location that is relative to the specified control for a specified duration.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public methodStatic member Move(Point) Moves the mouse to the specified location.
Public methodStatic member Move(UITestControl, Point) Moves the mouse to the specified location that is relative to the specified control.
Protected method MoveImplementation Moves the mouse to the specified location that is relative to the specified control.
Public methodStatic member MoveScrollWheel(Int32) Scrolls the mouse wheel the specified number of times.
Public methodStatic member MoveScrollWheel(Int32, ModifierKeys) Scrolls the mouse wheel the specified number of times while pressing the specified modifier keys.
Public methodStatic member MoveScrollWheel(UITestControl, Int32) Scrolls the mouse wheel on the specified control the specified number of times.
Public methodStatic member MoveScrollWheel(UITestControl, Int32, ModifierKeys) Scrolls the mouse wheel on the specified control the specified number of times while pressing the specified modifier keys.
Protected method MoveScrollWheelImplementation Scrolls the mouse wheel on the specified control the specified number of times while pressing the specified modifier keys.
Public methodStatic member StartDragging() Starts dragging the mouse.
Public methodStatic member StartDragging(UITestControl) Starts dragging the mouse from the specified control.
Public methodStatic member StartDragging(UITestControl, Point) Starts dragging the mouse from the specified point that is relative to the specified control or from an absolute control, if control is nulla null reference (Nothing in Visual Basic).
Public methodStatic member StartDragging(UITestControl, MouseButtons) Starts dragging the mouse while holding down the specified mouse buttons from the specified control.
Public methodStatic member StartDragging(UITestControl, Point, MouseButtons, ModifierKeys) Starts dragging the mouse while holding down the specified mouse buttons and the specified keys from the specified point that is relative to the specified control or from an absolute control, if control is nulla null reference (Nothing in Visual Basic).
Protected method StartDraggingImplementation Starts dragging the mouse while holding down the specified mouse buttons and the specified keys from the specified point relative to the specified control or from an absolute control, if control is nulla null reference (Nothing in Visual Basic).
Public methodStatic member StopDragging(Point) Stops the drag operation.
Public methodStatic member StopDragging(UITestControl) Stops the drag operation on the specified control.
Public methodStatic member StopDragging(Int32, Int32) Stops the drag operation.
Public methodStatic member StopDragging(UITestControl, Point) Stops the drag operation on the specified control.
Public methodStatic member StopDragging(UITestControl, Int32, Int32) Stops the drag operation on the specified control.
Protected method StopDraggingImplementation Stops the drag operation on the specified control.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.VisualStudio.TestTools.UITesting Namespace