EdgeGesture EdgeGesture EdgeGesture EdgeGesture EdgeGesture Class


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

public : sealed class EdgeGesture
struct winrt::Windows::UI::Input::EdgeGesture
public sealed class EdgeGesture
Public NotInheritable Class EdgeGesture
// This class does not provide a public constructor.

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)


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);



: 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).


GetForCurrentView() GetForCurrentView() GetForCurrentView() GetForCurrentView() GetForCurrentView()

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


Canceled Canceled Canceled Canceled Canceled

Fires when a user cancels a show or hide action for an edge-based UI.

Completed Completed Completed Completed 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 Starting Starting Starting Starting

Fires when a user begins an action to summon or dismiss edge-based UI.

See also