Mouse​Capabilities Mouse​Capabilities Mouse​Capabilities Mouse​Capabilities Class

Definition

Namespace:
Windows.Devices.Input Windows.Devices.Input Windows.Devices.Input Windows.Devices.Input
Edit

Supports the ability to determine the capabilities of any connected mouse devices.

public : sealed class MouseCapabilities : IMouseCapabilitiespublic sealed class MouseCapabilities : IMouseCapabilitiesPublic NotInheritable Class MouseCapabilities Implements IMouseCapabilities// You can use this class in JavaScript.
Attributes
ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The values returned by the properties discussed here are based on the total number of mice connected: Boolean properties return true if one mouse supports a specific capability and numeric properties return the maximum value exposed by all mice.

The Device Capabilities Sample demonstrates how to detect the presence of input devices and retrieve the capabilities and attributes of each device.

Constructors

MouseCapabilities() MouseCapabilities() MouseCapabilities() MouseCapabilities()

Edit

Initializes a new instance of the MouseCapabilities class.

public : MouseCapabilities()public MouseCapabilities()Public Sub New()// You can use this method in JavaScript.

Examples

The following code shows how to create an instance of the MouseCapabilities class.

function getMouseCapabilities() {
  var mouseCapabilities = new Windows.Devices.Input.MouseCapabilities();
}
See Also
Quickstart: Identifying input devices

Properties

HorizontalWheelPresent HorizontalWheelPresent HorizontalWheelPresent HorizontalWheelPresent

Edit

Gets a value indicating whether any of the mice connected to the computer have a scroll wheel that tilts left and right (usually for horizontal scrolling).

public : int HorizontalWheelPresent { get; }public int HorizontalWheelPresent { get; }Public ReadOnly Property HorizontalWheelPresent As int// You can use this property in JavaScript.
Value
int int int int

The number of horizontal wheels detected. Typically 0 or 1.

Examples

The following code shows how to use this method.

    function getMouseCapabilities() {
        var mouseCapabilities = new Windows.Devices.Input.MouseCapabilities();
        id("horizontalWheelPresent").innerHTML = mouseCapabilities.HorizontalWheelPresent;
    }
See Also
Quickstart: Identifying input devices

MousePresent MousePresent MousePresent MousePresent

Edit

Gets a value that indicates whether a mouse device is detected.

public : int MousePresent { get; }public int MousePresent { get; }Public ReadOnly Property MousePresent As int// You can use this property in JavaScript.
Value
int int int int

The number of mouse devices detected. Typically 0 or 1.

Examples

The following code shows how to use this method.

    function getMouseCapabilities() {
        var mouseCapabilities = new Windows.Devices.Input.MouseCapabilities();
        id("mousePresent").innerHTML = mouseCapabilities.MousePresent;
    }
See Also
Quickstart: Identifying input devices

NumberOfButtons NumberOfButtons NumberOfButtons NumberOfButtons

Edit

Gets a value representing the number of buttons on the mouse. If multiple mice are present, it returns the number of buttons of the mouse which has maximum number of buttons.

public : unsigned short NumberOfButtons { get; }public uint NumberOfButtons { get; }Public ReadOnly Property NumberOfButtons As uint// You can use this property in JavaScript.
Value
unsigned short uint uint uint

A value representing the number of buttons on the mouse. If multiple mice are present, it returns the number of buttons of the mouse which has maximum number of buttons.

Examples

The following code shows how to use this method.

    function getMouseCapabilities() {
        var mouseCapabilities = new Windows.Devices.Input.MouseCapabilities();
        id("numberOfButtons").innerHTML = mouseCapabilities.NumberOfButtons;
    }
See Also
Quickstart: Identifying input devices

SwapButtons SwapButtons SwapButtons SwapButtons

Edit

Gets a value indicating whether any of the mice connected to the computer has swapped left and right buttons.

public : int SwapButtons { get; }public int SwapButtons { get; }Public ReadOnly Property SwapButtons As int// You can use this property in JavaScript.
Value
int int int int

A value indicating whether any of the mice connected to the computer has swapped left and right buttons.

Examples

The following code shows how to use this method.

    function getMouseCapabilities() {
        var mouseCapabilities = new Windows.Devices.Input.MouseCapabilities();
        id("swapButtons").innerHTML = mouseCapabilities.SwapButtons;
    }
See Also
Quickstart: Identifying input devices

VerticalWheelPresent VerticalWheelPresent VerticalWheelPresent VerticalWheelPresent

Edit

Gets a value indicating whether any of the mice connected to the computer have a scroll wheel that rolls up and down (usually for vertical scrolling).

public : int VerticalWheelPresent { get; }public int VerticalWheelPresent { get; }Public ReadOnly Property VerticalWheelPresent As int// You can use this property in JavaScript.
Value
int int int int

The number of vertical wheels detected. Typically 0 or 1.

Examples

The following code shows how to use this method.

    function getMouseCapabilities() {
        var mouseCapabilities = new Windows.Devices.Input.MouseCapabilities();
        id("verticalWheelPresent").innerHTML = mouseCapabilities.VerticalWheelPresent;
    }
See Also
Quickstart: Identifying input devices

See Also