UINavigationController Class

Definition

Represents a controller of any type that can be used for UI navigation. Most gamepads, arcade sticks, and racing wheels can also be accessed as a UINavigationController. It is recommended that games use the controller-specific class during gameplay and the UINavigationController class for UI menus.

public ref class UINavigationController sealed
public ref class UINavigationController sealed : IGameControllerBatteryInfo
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 196608)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class UINavigationController final
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 196608)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class UINavigationController final : IGameControllerBatteryInfo
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 196608)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class UINavigationController
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 196608)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class UINavigationController : IGameControllerBatteryInfo
Public NotInheritable Class UINavigationController
Public NotInheritable Class UINavigationController
Implements IGameControllerBatteryInfo
Inheritance
Object Platform::Object IInspectable UINavigationController
Attributes
Implements

Windows requirements

Device family
Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v3.0)

Remarks

Version history

Windows version SDK version Value added
1703 15063 FromGameController
1703 15063 TryGetBatteryReport

Properties

Headset

The audio headset attached to the UI navigation controller.

IsWireless

Gets a value that indicates the wireless state of the UI navigation controller.

UINavigationControllers

The list of all connected UI navigation controllers.

User

The user associated with the UI navigation controller.

Methods

FromGameController(IGameController)

Returns the given game controller as a UI navigation controller.

GetCurrentReading()

Gets a snapshot of the UI navigation controller's state.

GetOptionalButtonLabel(OptionalUINavigationButtons)

Retrieves a label for an optional UI navigation button.

GetRequiredButtonLabel(RequiredUINavigationButtons)

Retrieves a label for a required UI navigation button.

TryGetBatteryReport()

Gets information about the UI navigation controller's current battery state.

Events

HeadsetConnected

Signals when a headset is attached to the UI navigation controller.

HeadsetDisconnected

Signals when a headset is disconnected from the UI navigation controller.

UINavigationControllerAdded

Signals when a new UI navigation controller is connected.

UINavigationControllerRemoved

Signals when a UI navigation controller is disconnected.

UserChanged

Signals when the user associated with the UI navigation controller has changed.

Applies to

See also