CoreComponentInputSource CoreComponentInputSource CoreComponentInputSource Class

Definition

Provides a mechanism to receive input for a XAML framework element hosted in another framework, such as a DirectX interop framework.

public sealed class CoreComponentInputSourcepublic sealed class CoreComponentInputSourcePublic NotInheritable Class CoreComponentInputSource
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Properties

Dispatcher Dispatcher Dispatcher Dispatcher

Gets the input event dispatcher for the hosted XAML framework element.

public CoreDispatcher Dispatcher { get; }public CoreDispatcher Dispatcher { get; }Public ReadOnly Property Dispatcher As CoreDispatcherpublic CoreDispatcher Dispatcher { get; }
Value
CoreDispatcher CoreDispatcher CoreDispatcher

The dispatcher object for the hosted XAML framework element.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

HasCapture HasCapture HasCapture HasCapture

Indicates whether the input device supports input capture.

public bool HasCapture { get; }public bool HasCapture { get; }Public ReadOnly Property HasCapture As boolpublic bool HasCapture { get; }
Value
bool bool bool

true if the input device supports capture (recording of input data); false if it does not.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

HasFocus HasFocus HasFocus HasFocus

Gets whether the current hosted XAML control element has focus. If it does, keyboard input is delivered to that control.

public bool HasFocus { get; }public bool HasFocus { get; }Public ReadOnly Property HasFocus As boolpublic bool HasFocus { get; }
Value
bool bool bool

true if the element has focus; false if it does not.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

IsInputEnabled IsInputEnabled IsInputEnabled IsInputEnabled

Gets or sets whether input is enabled for the hosted XAML framework element.

public bool IsInputEnabled { get; set; }public bool IsInputEnabled { get; set; }Public ReadWrite Property IsInputEnabled As boolpublic bool IsInputEnabled { get; set; }
Value
bool bool bool

true if input is enabled; false if it is not.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

PointerCursor PointerCursor PointerCursor PointerCursor

Gets the pointer cursor behavior for interactions with the hosted XAML framework element.

public CoreCursor PointerCursor { get; set; }public CoreCursor PointerCursor { get; set; }Public ReadWrite Property PointerCursor As CoreCursorpublic CoreCursor PointerCursor { get; set; }
Value
CoreCursor CoreCursor CoreCursor

The pointer cursor object.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

PointerPosition PointerPosition PointerPosition PointerPosition

Gets the current pointer position in the hosted XAML framework.

public Point PointerPosition { get; }public Point PointerPosition { get; }Public ReadOnly Property PointerPosition As Pointpublic Point PointerPosition { get; }
Value
Point Point Point

The current pointer position.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Methods

GetCurrentKeyEventDeviceId() GetCurrentKeyEventDeviceId() GetCurrentKeyEventDeviceId() GetCurrentKeyEventDeviceId()

Retrieves the unique ID for the input device that generated this key event.

GetCurrentKeyEventDeviceId() is not supported for all input devices.

public string GetCurrentKeyEventDeviceId()public string GetCurrentKeyEventDeviceId()Public Function GetCurrentKeyEventDeviceId() As stringpublic string GetCurrentKeyEventDeviceId()
Returns
string string string

A unique identifier for the input device associated with the key event, or an empty string. The same device can be assigned a different ID each time it is connected.

After a key event is processed, this method returns an empty string.

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Use GetCurrentKeyEventDeviceId() to differentiate between devices that can generate key events, such as multiple Xbox controllers. The device id is useful for associating the input device with a specific user account.

To get a valid device ID, this method must be called from your KeyUp and KeyDown event handlers.

GetCurrentKeyState(VirtualKey) GetCurrentKeyState(VirtualKey) GetCurrentKeyState(VirtualKey) GetCurrentKeyState(VirtualKey)

Gets the current status of a virtual key press.

public CoreVirtualKeyStates GetCurrentKeyState(VirtualKey virtualKey)public CoreVirtualKeyStates GetCurrentKeyState(VirtualKey virtualKey)Public Function GetCurrentKeyState(virtualKey As VirtualKey) As CoreVirtualKeyStatespublic CoreVirtualKeyStates GetCurrentKeyState(VirtualKey virtualKey)
Parameters
virtualKey
VirtualKey VirtualKey VirtualKey

The key from which to retrieve status.

Returns

The flags indicating the current state of the supplied virtual key when the input event fired.

Note

All keys support the Locked state (not just the standard Caps Lock and Num Lock keys).

Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

ReleasePointerCapture() ReleasePointerCapture() ReleasePointerCapture() ReleasePointerCapture()

Stops the capture of pointer input data (if the pointing device supports input capture).

public void ReleasePointerCapture()public void ReleasePointerCapture()Public Function ReleasePointerCapture() As voidpublic void ReleasePointerCapture()
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

SetPointerCapture() SetPointerCapture() SetPointerCapture() SetPointerCapture()

Starts the capture of pointer input data (if the pointing device supports input capture).

public void SetPointerCapture()public void SetPointerCapture()Public Function SetPointerCapture() As voidpublic void SetPointerCapture()
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Events

CharacterReceived CharacterReceived CharacterReceived CharacterReceived

Raised when a character is received (such as from a completed key press sequence) by the hosted XAML element.

public event TypedEventHandler CharacterReceivedpublic event TypedEventHandler CharacterReceivedPublic Event CharacterReceivedpublic event TypedEventHandler CharacterReceived
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

ClosestInteractiveBoundsRequested ClosestInteractiveBoundsRequested ClosestInteractiveBoundsRequested ClosestInteractiveBoundsRequested

Note

Not intended for general use.

Occurs when a framework input manager requests the bounding rectangle of an interactive element within a specific bounding rectangle and closest to a specific pointer.

public event TypedEventHandler ClosestInteractiveBoundsRequestedpublic event TypedEventHandler ClosestInteractiveBoundsRequestedPublic Event ClosestInteractiveBoundsRequestedpublic event TypedEventHandler ClosestInteractiveBoundsRequested
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

GotFocus GotFocus GotFocus GotFocus

Raised when a hosted XAML element gets focus.

public event TypedEventHandler GotFocuspublic event TypedEventHandler GotFocusPublic Event GotFocuspublic event TypedEventHandler GotFocus
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

InputEnabled InputEnabled InputEnabled InputEnabled

Raised when the hosted XAML control is enabled for input.

public event TypedEventHandler InputEnabledpublic event TypedEventHandler InputEnabledPublic Event InputEnabledpublic event TypedEventHandler InputEnabled
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

KeyDown KeyDown KeyDown KeyDown

Raised when a key is pressed for the current active hosted XAML element.

public event TypedEventHandler KeyDownpublic event TypedEventHandler KeyDownPublic Event KeyDownpublic event TypedEventHandler KeyDown
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

KeyUp KeyUp KeyUp KeyUp

Raised when a key press is released for the current active hosted XAML element.

public event TypedEventHandler KeyUppublic event TypedEventHandler KeyUpPublic Event KeyUppublic event TypedEventHandler KeyUp
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

LostFocus LostFocus LostFocus LostFocus

Raised when a hosted XAML element loses focus.

public event TypedEventHandler LostFocuspublic event TypedEventHandler LostFocusPublic Event LostFocuspublic event TypedEventHandler LostFocus
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

PointerCaptureLost PointerCaptureLost PointerCaptureLost PointerCaptureLost

Raised when the pointer input capture stream is lost.

public event TypedEventHandler PointerCaptureLostpublic event TypedEventHandler PointerCaptureLostPublic Event PointerCaptureLostpublic event TypedEventHandler PointerCaptureLost
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

This event is only raised if the input device supports pointer data capture.

PointerEntered PointerEntered PointerEntered PointerEntered

Raised when the pointer enters the hosted XAML element.

public event TypedEventHandler PointerEnteredpublic event TypedEventHandler PointerEnteredPublic Event PointerEnteredpublic event TypedEventHandler PointerEntered
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

PointerExited PointerExited PointerExited PointerExited

Raised when the pointer exits the hosted XAML element.

public event TypedEventHandler PointerExitedpublic event TypedEventHandler PointerExitedPublic Event PointerExitedpublic event TypedEventHandler PointerExited
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

PointerMoved PointerMoved PointerMoved PointerMoved

Raised when the pointer is moved for the active hosted XAML element.

public event TypedEventHandler PointerMovedpublic event TypedEventHandler PointerMovedPublic Event PointerMovedpublic event TypedEventHandler PointerMoved
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

PointerPressed PointerPressed PointerPressed PointerPressed

Raised when the pointer is "pressed" (such as a mouse button click or full screen press) for the active hosted XAML element.

public event TypedEventHandler PointerPressedpublic event TypedEventHandler PointerPressedPublic Event PointerPressedpublic event TypedEventHandler PointerPressed
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

PointerReleased PointerReleased PointerReleased PointerReleased

Raised when the pointer is released (such as when a mouse button click or screen press is released) for the active hosted XAML element.

public event TypedEventHandler PointerReleasedpublic event TypedEventHandler PointerReleasedPublic Event PointerReleasedpublic event TypedEventHandler PointerReleased
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

PointerWheelChanged PointerWheelChanged PointerWheelChanged PointerWheelChanged

Raised when the mouse wheel is rotated for the active hosted XAML element.

public event TypedEventHandler PointerWheelChangedpublic event TypedEventHandler PointerWheelChangedPublic Event PointerWheelChangedpublic event TypedEventHandler PointerWheelChanged
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

TouchHitTesting TouchHitTesting TouchHitTesting TouchHitTesting

Raised for a touch hit test on a hosted XAML element.

public event TypedEventHandler TouchHitTestingpublic event TypedEventHandler TouchHitTestingPublic Event TouchHitTestingpublic event TypedEventHandler TouchHitTesting
Attributes
Additional features and requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)