Core​Component​Input​Source Core​Component​Input​Source Core​Component​Input​Source Core​Component​Input​Source 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 CoreComponentInputSource : ICoreClosestInteractiveBoundsRequested, ICoreComponentFocusable, ICoreInputSourceBase, ICoreKeyboardInputSource, ICoreKeyboardInputSource2, ICorePointerInputSource, ICoreTouchHitTestingpublic sealed class CoreComponentInputSource : ICoreClosestInteractiveBoundsRequested, ICoreComponentFocusable, ICoreInputSourceBase, ICoreKeyboardInputSource, ICoreKeyboardInputSource2, ICorePointerInputSource, ICoreTouchHitTestingPublic NotInheritable Class CoreComponentInputSource Implements ICoreClosestInteractiveBoundsRequested, ICoreComponentFocusable, ICoreInputSourceBase, ICoreKeyboardInputSource, ICoreKeyboardInputSource2, ICorePointerInputSource, ICoreTouchHitTesting// This API is not available in Javascript.
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 CoreDispatcher// This API is not available in Javascript.
Value
CoreDispatcher CoreDispatcher CoreDispatcher CoreDispatcher

The dispatcher object for the hosted XAML framework element.

HasCapture HasCapture HasCapture HasCapture

Indicates whether the input device supports input capture.

public : PlatForm::Boolean HasCapture { get; }public bool HasCapture { get; }Public ReadOnly Property HasCapture As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

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

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 : PlatForm::Boolean HasFocus { get; }public bool HasFocus { get; }Public ReadOnly Property HasFocus As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

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

IsInputEnabled IsInputEnabled IsInputEnabled IsInputEnabled

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

public : PlatForm::Boolean IsInputEnabled { get; set; }public bool IsInputEnabled { get; set; }Public ReadWrite Property IsInputEnabled As bool// This API is not available in Javascript.
Value
PlatForm::Boolean bool bool bool

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

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 CoreCursor// This API is not available in Javascript.
Value
CoreCursor CoreCursor CoreCursor CoreCursor

The pointer cursor object.

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 Point// This API is not available in Javascript.
Value
Point Point Point Point

The current pointer position.

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 : PlatForm::String GetCurrentKeyEventDeviceId()public string GetCurrentKeyEventDeviceId()Public Function GetCurrentKeyEventDeviceId() As string// This API is not available in Javascript.
Returns
PlatForm::String 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.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

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 CoreVirtualKeyStates// This API is not available in Javascript.
Parameters
virtualKey
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).

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 void// This API is not available in Javascript.

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 void// This API is not available in Javascript.

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 CharacterReceived<object,  CharacterReceivedEventArgs>public event TypedEventHandler CharacterReceived<object,  CharacterReceivedEventArgs>Public Event CharacterReceived<object,  CharacterReceivedEventArgs>// This API is not available in Javascript.

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 ClosestInteractiveBoundsRequested<CoreComponentInputSource,  ClosestInteractiveBoundsRequestedEventArgs>public event TypedEventHandler ClosestInteractiveBoundsRequested<CoreComponentInputSource,  ClosestInteractiveBoundsRequestedEventArgs>Public Event ClosestInteractiveBoundsRequested<CoreComponentInputSource,  ClosestInteractiveBoundsRequestedEventArgs>// This API is not available in Javascript.
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

GotFocus GotFocus GotFocus GotFocus

Raised when a hosted XAML element gets focus.

public : event TypedEventHandler GotFocus<object,  CoreWindowEventArgs>public event TypedEventHandler GotFocus<object,  CoreWindowEventArgs>Public Event GotFocus<object,  CoreWindowEventArgs>// This API is not available in Javascript.

InputEnabled InputEnabled InputEnabled InputEnabled

Raised when the hosted XAML control is enabled for input.

public : event TypedEventHandler InputEnabled<object,  InputEnabledEventArgs>public event TypedEventHandler InputEnabled<object,  InputEnabledEventArgs>Public Event InputEnabled<object,  InputEnabledEventArgs>// This API is not available in Javascript.

KeyDown KeyDown KeyDown KeyDown

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

public : event TypedEventHandler KeyDown<object,  KeyEventArgs>public event TypedEventHandler KeyDown<object,  KeyEventArgs>Public Event KeyDown<object,  KeyEventArgs>// This API is not available in Javascript.

KeyUp KeyUp KeyUp KeyUp

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

public : event TypedEventHandler KeyUp<object,  KeyEventArgs>public event TypedEventHandler KeyUp<object,  KeyEventArgs>Public Event KeyUp<object,  KeyEventArgs>// This API is not available in Javascript.

LostFocus LostFocus LostFocus LostFocus

Raised when a hosted XAML element loses focus.

public : event TypedEventHandler LostFocus<object,  CoreWindowEventArgs>public event TypedEventHandler LostFocus<object,  CoreWindowEventArgs>Public Event LostFocus<object,  CoreWindowEventArgs>// This API is not available in Javascript.

PointerCaptureLost PointerCaptureLost PointerCaptureLost PointerCaptureLost

Raised when the pointer input capture stream is lost.

public : event TypedEventHandler PointerCaptureLost<object,  PointerEventArgs>public event TypedEventHandler PointerCaptureLost<object,  PointerEventArgs>Public Event PointerCaptureLost<object,  PointerEventArgs>// This API is not available in Javascript.

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 PointerEntered<object,  PointerEventArgs>public event TypedEventHandler PointerEntered<object,  PointerEventArgs>Public Event PointerEntered<object,  PointerEventArgs>// This API is not available in Javascript.

PointerExited PointerExited PointerExited PointerExited

Raised when the pointer exits the hosted XAML element.

public : event TypedEventHandler PointerExited<object,  PointerEventArgs>public event TypedEventHandler PointerExited<object,  PointerEventArgs>Public Event PointerExited<object,  PointerEventArgs>// This API is not available in Javascript.

PointerMoved PointerMoved PointerMoved PointerMoved

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

public : event TypedEventHandler PointerMoved<object,  PointerEventArgs>public event TypedEventHandler PointerMoved<object,  PointerEventArgs>Public Event PointerMoved<object,  PointerEventArgs>// This API is not available in Javascript.

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 PointerPressed<object,  PointerEventArgs>public event TypedEventHandler PointerPressed<object,  PointerEventArgs>Public Event PointerPressed<object,  PointerEventArgs>// This API is not available in Javascript.

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 PointerReleased<object,  PointerEventArgs>public event TypedEventHandler PointerReleased<object,  PointerEventArgs>Public Event PointerReleased<object,  PointerEventArgs>// This API is not available in Javascript.

PointerWheelChanged PointerWheelChanged PointerWheelChanged PointerWheelChanged

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

public : event TypedEventHandler PointerWheelChanged<object,  PointerEventArgs>public event TypedEventHandler PointerWheelChanged<object,  PointerEventArgs>Public Event PointerWheelChanged<object,  PointerEventArgs>// This API is not available in Javascript.

TouchHitTesting TouchHitTesting TouchHitTesting TouchHitTesting

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

public : event TypedEventHandler TouchHitTesting<object,  TouchHitTestingEventArgs>public event TypedEventHandler TouchHitTesting<object,  TouchHitTestingEventArgs>Public Event TouchHitTesting<object,  TouchHitTestingEventArgs>// This API is not available in Javascript.