1 out of 1 rated this helpful - Rate this topic

EdgeGesture class

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

Syntax


var edgeGesture = Windows.UI.Input.EdgeGesture;

Attributes

MarshalingBehaviorAttribute(Standard)
MuseAttribute()
StaticAttribute(Windows.UI.Input.IEdgeGestureStatics, NTDDI_WIN8)
ThreadingAttribute(STA)
VersionAttribute(NTDDI_WIN8)

Members

The EdgeGesture class has these types of members:

Events
Methods

Events

The EdgeGesture class has these events.

Event	Description
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.

Method	Description
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).

Windows Phone 8

This API is not implemented and will throw an exception if called.

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
Namespace	Windows.UI.Input Windows::UI::Input [C++]
Metadata	Windows.winmd