SystemButtonEventController Class

Reference

Definition

Namespace:: Windows.UI.Input

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Enables the ability to handle events generated by hardware system buttons (such as the Function buttons).

public ref class SystemButtonEventController sealed : AttachableInputObject

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 655360)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class SystemButtonEventController final : AttachableInputObject

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 655360)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class SystemButtonEventController : AttachableInputObject

Public NotInheritable Class SystemButtonEventController
Inherits AttachableInputObject

Inheritance: Object Platform::Object IInspectable AttachableInputObject SystemButtonEventController

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family	Windows 10, version 2004 (introduced in 10.0.19041.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v10.0)

Remarks

This API is intended for use by Accessibility tools as a low level hook for intercepting events from hardware system buttons.

SystemButtonEventController event registration applies system wide and is first-come, first-served. If an application or service sets a SystemButtonEventController event Handled property to true, applications or services that registered after that app or service for the same event notification will not receive the notification.

Methods

Close()

Terminates the AttachableInputObject instance.

(Inherited from AttachableInputObject)

CreateForDispatcherQueue(DispatcherQueue)

Creates a SystemButtonEventController object on the specified dispatcher queue.

All events are fired on the queue thread.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

(Inherited from AttachableInputObject)

Events

SystemFunctionButtonPressed	Occurs when a Fn hardware system (also know as Function Shift) button is pressed.
SystemFunctionButtonReleased	Occurs when a Fn hardware system (also know as Function Shift) button, which is currently pressed, is released.
SystemFunctionLockChanged	Occurs on changes to the state of the Fn hardware system (also know as Function Shift) button lock.
SystemFunctionLockIndicatorChanged	Occurs on changes to the state of the visual indicator for the Fn hardware system (also know as Function Shift) button lock.

Applies to

Share via