This documentation is archived and is not being maintained.

Mouse Class

Provides properties for getting information about the format and configuration of the mouse installed on the local computer.


Namespace:  Microsoft.VisualBasic.Devices
Assembly:  Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

[HostProtectionAttribute(SecurityAction.LinkDemand, Resources = HostProtectionResource.ExternalProcessMgmt)]
public class Mouse

The Mouse type exposes the following members.

Public methodMouseInitializes a new instance of the Mouse class.

Public propertyButtonsSwappedGets a Boolean that indicates if the functionality of the left and right mouse buttons has been swapped.
Public propertyWheelExistsGets a Boolean that indicates if the mouse has a scroll wheel.
Public propertyWheelScrollLinesGets a number that indicates how much to scroll when the mouse wheel is rotated one notch.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The My.Computer.Mouse object provides a way to find information about the computer's mouse: whether the mouse buttons are swapped, and details about the mouse wheel.

Availability by Project Type

Project type


Windows Application


Class Library


Console Application


Windows Control Library


Web Control Library


Windows Service


Web Site



The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: Resources. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

This example uses the My.Computer.Mouse.WheelExists and My.Computer.Mouse.WheelScrollLines properties to determine if the mouse has a scroll wheel and how much to scroll when it rotates.

If My.Computer.Mouse.WheelExists Then
    Dim lines As Integer = My.Computer.Mouse.WheelScrollLines
    If lines > 0 Then
        MsgBox("Application scrolls " & 
            lines & " line(s) for each wheel turn.")
        MsgBox("Application scrolls " & 
            (-lines) & " page(s) for each wheel turn.")
    End If
    MsgBox("Mouse has no scroll wheel.")
End If

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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