Expand Minimize

PointerPointProperties class

Applies to Windows and Windows Phone

Provides extended properties for a PointerPoint object.

In most cases, we recommend that you obtain pointer info through the pointer event handlers of your chosen Windows 8 language framework (Windows Store apps using JavaScript, Windows Store apps using C++, C#, or Visual Basic, or Windows Store apps using DirectX with C++).

If the event argument doesn't expose the pointer details required by your app, you can get access to extended pointer data from the event argument through the getCurrentPoint and getIntermediatePoints methods or currentPoint and intermediatePoints properties. We recommend using the getCurrentPoint and getIntermediatePoints methods as you can specify the context of the pointer data.

The static PointerPoint methods, GetCurrentPoint and GetIntermediatePoints, always use the context of the app.

Syntax


public ref class PointerPointProperties sealed 

Attributes

[MarshalingBehavior(None)]
[Version(0x06020000)]

Members

The PointerPointProperties class has these types of members:

Methods

The PointerPointProperties class has these methods. With C#, Visual Basic, and C++, it also inherits methods from the Object class.

MethodDescription
GetUsageValue Gets the Human Interface Device (HID) usage value of the raw input.
HasUsage Gets a value that indicates whether the input data from the pointer device contains the specified Human Interface Device (HID) usage information.

 

Properties

The PointerPointProperties class has these properties.

PropertyAccess typeDescription

ContactRect

Read-onlyGets the bounding rectangle of the contact area (typically from touch input).

ContactRectRaw

Read-onlyGets the bounding rectangle of the raw input (typically from touch input).

IsBarrelButtonPressed

Read-onlyGets a value that indicates whether the barrel button of the pen/stylus device is pressed.

IsCanceled

Read-onlyGets a value that indicates whether the input was canceled by the pointer device.

IsEraser

Read-onlyGets a value that indicates whether the input is from a digitizer eraser.

IsHorizontalMouseWheel

Read-onlyGets a value that indicates whether the input is from a mouse tilt wheel.

IsInRange

Read-onlyGets a value that indicates whether the pointer device is within detection range of a sensor or digitizer.

IsInverted

Read-onlyGets a value that indicates whether the digitizer pen is inverted.

IsLeftButtonPressed

Read-onlyGets a value that indicates whether the input is from the left button of a mouse or other input method.

IsMiddleButtonPressed

Read-onlyGets a value that indicates whether the input is from the middle button of a mouse or other input method.

IsPrimary

Read-onlyGets a value that indicates whether the input is from the primary pointer when multiple pointers are registered.

IsRightButtonPressed

Read-onlyGets a value that indicates whether the input is from the right button of a mouse or other input method.

IsXButton1Pressed

Read-onlyGets the pressed state of the first extended mouse button.

IsXButton2Pressed

Read-onlyGets the pressed state of the second extended mouse button.

MouseWheelDelta

Read-onlyGets a value (the raw value reported by the device) that indicates the change in wheel button input from the last pointer event.

Orientation

Read-onlyGets the counter-clockwise angle of rotation around the major axis of the pointer device (the z-axis, perpendicular to the surface of the digitizer).

PointerUpdateKind

Read-onlyGets the kind of pointer state change.

Pressure

Read-onlyGets a value that indicates the force that the pointer device (typically a pen/stylus) exerts on the surface of the digitizer.

TouchConfidence

Read-onlyGets a value that indicates whether the pointer device rejected the touch contact.

Twist

Read-onlyGets the clockwise rotation in degrees of a pen device around its own major axis (such as when the user spins the pen in their fingers).

XTilt

Read-onlyGets the plane angle between the Y-Z plane and the plane that contains the Y axis and the axis of the input device (typically a pen/stylus).

YTilt

Read-onlyGets the plane angle between the X-Z plane and the plane that contains the X axis and the axis of the input device (typically a pen/stylus).

 

Remarks

The PointerPointProperties class implements IPointerPointProperties.

Note  : This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX) and Using Windows Runtime objects in a multithreaded environment (.NET).

Examples

In the following example, we query various extended pointer properties using a PointerPoint object.

No code example is currently available or this language may not be supported.

Requirements

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8

Namespace

Windows.UI.Input
Windows::UI::Input [C++]

Metadata

Windows.winmd

See also

Reference
Windows.UI.Input Classes
Windows.UI.Input.PointerPoint.properties
Windows.Devices.Input
Windows.UI.Core
Windows.UI.Input
Windows.UI.Input.Inking
Windows.UI.Xaml.Input
TypedEventHandler
Conceptual
Responding to user interaction
Guidelines for common user interactions
Developing Windows Store apps (JavaScript and HTML)
Using the Windows Runtime in JavaScript
Touch interaction design
Samples (DOM)
HTML scrolling, panning and zooming sample
Input: DOM pointer event handling sample
Input: Instantiable gestures sample
Samples (Windows Store app APIs)
Input: Device capabilities sample
Input: Ink sample
Input: Manipulations and gestures (JavaScript) sample
Input: Simplified ink sample
Input: Windows 8 gestures sample
Input: XAML user input events sample
XAML scrolling, panning, and zooming sample
Samples (DirectX)
DirectX touch input sample
Input: Manipulations and gestures (C++) sample
Input: Touch hit testing sample
Samples (Win32/Desktop)
Input source identification sample
Touch injection sample
Win32 touch hit-testing sample

 

 

Show:
© 2014 Microsoft