EdgeGesture class

Applies to Windows and Windows Phone

Provides access to the events that notify an app of triggers to its edge-based UI.

Syntax


public sealed class EdgeGesture

Attributes

[MarshalingBehavior(Standard)]
[Muse()]
[Threading(STA)]
[Version(0x06020000)]

Members

The EdgeGesture class has these types of members:

Events

The EdgeGesture class has these events.

EventDescription
Canceled Fires when a user cancels a show or hide action for an edge-based UI.
Completed Fires to indicate that the user has successfully summoned or dismissed the edge-based UI. This occurs either when the user lifts his or her finger from a touch-enabled screen or when the user presses Win+Z on the keyboard.
Starting Fires when a user begins an action to summon or dismiss edge-based UI.

 

Methods

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

MethodDescription
GetForCurrentView Gets an instance of the EdgeGesture class that is used to add and remove event delegate handlers for the current view.

 

Remarks

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

The following example demonstrates the use of GetForCurrentView to retrieve an instance EdgeGesture through which it then registers for each of the edge gesture events.



var edgeGesture = Windows.UI.Input.EdgeGesture.getForCurrentView();
edgeGesture.addEventListener("starting", onStarting);
edgeGesture.addEventListener("completed", onCompleted);
edgeGesture.addEventListener("canceled", onCanceled);

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.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Namespace

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

Metadata

Windows.winmd

See also

Reference
Windows.UI.Input Classes
Windows.Devices.Input
Windows.UI.Core
Windows.UI.Input
Windows.UI.Input.Inking
Windows.UI.Xaml.Input
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)
Edge gesture invocation sample
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