RequiresPointer Enum

Definition

Defines constants that specify when an element requires a mouse-like pointer behavior from a game controller.

C#
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.UI.Xaml.WinUIContract), 65536)]
public enum RequiresPointer
Inheritance
RequiresPointer
Attributes

Fields

Name Value Description
Never 0

The pointer never acts as a mouse.

WhenEngaged 1

The pointer acts as a mouse when the user engages mouse-mode.

WhenFocused 2

The pointer acts as a mouse when the page gets focus. Supported on Page elements only.

Remarks

This enumeration provides values for the Control.RequiresPointer property.

For non-pointer input devices, focus is moved between controls through a variety of methods, such as the Tab and arrow keys on a keyboard or the directional pad (D-pad) and thumb sticks on a game controller. For some user experiences, such as maps and drawing surfaces, it is not possible or practical to use XY focus navigation. RequiresPointer enables an app to provide a more pointer-like interaction experience through a cursor that can be moved freely using the game controller.

RequiresPointer is supported only when using a game controller. The property is ignored otherwise.

For more info, see the Mouse mode section of Designing for Xbox and TV.

Applies to

Product Versions
Windows App SDK 0.8, 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6