Share via


InkPicture.SystemGesture Event

Occurs when a system gesture is recognized.

Namespace:  Microsoft.Ink
Assembly:  Microsoft.Ink (in Microsoft.Ink.dll)

Syntax

'Declaration
Public Event SystemGesture As InkCollectorSystemGestureEventHandler
'Usage
Dim instance As InkPicture 
Dim handler As InkCollectorSystemGestureEventHandler 

AddHandler instance.SystemGesture, handler
public event InkCollectorSystemGestureEventHandler SystemGesture
public:
 event InkCollectorSystemGestureEventHandler^ SystemGesture {
    void add (InkCollectorSystemGestureEventHandler^ value);
    void remove (InkCollectorSystemGestureEventHandler^ value);
}
JScript does not support events.

Remarks

System gestures give information about the Cursor object that is being used to create the gesture. They also provide shortcuts to combinations of mouse events and are effective ways to detect mouse events.

For example, instead of listening for a MouseUpand MouseDownpair of events with no other mouse events occurring in between, you can listen for the Tap or RightTap system gestures.

As another example, instead of listening for MouseDownand MouseMoveevents and getting numerous MouseMovemessages, you can listen for the Drag or RightDrag system gestures, as long as you do not need the (x, y) coordinates of every position of the mouse. This allows you to receive only one message instead of numerous MouseMovemessages.

For a list of specific system gestures, see the SystemGesture enumeration type. For more information about system gestures, see Using Gestures and Command Input on the Tablet PC.

The event handler receives an argument of type InkCollectorSystemGestureEventArgs that contains data about this event.

When you create an InkCollectorSystemGestureEventHandler delegate, you identify the method that handles the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate.

Examples

The event handler in this example displays system gesture information on a status bar label, statusLabelSysGesture.

Private Sub Event_OnSystemGesture(ByVal sender As Object, ByVal e As InkCollectorSystemGestureEventArgs)
    Select Case e.Id
        Case SystemGesture.Tap
            Me.statusLabelSysGesture.Text = "Tap" 
        Case SystemGesture.DoubleTap
            Me.statusLabelSysGesture.Text = "Double Tap" 

    End Select 
End Sub
private void Event_OnSystemGesture(object sender, InkCollectorSystemGestureEventArgs e)
{
    switch (e.Id)
    {
        case SystemGesture.Tap:
            this.statusLabelSysGesture.Text = "Tap";
            break;
        case SystemGesture.DoubleTap:
            this.statusLabelSysGesture.Text = "Double Tap";
            break;
    }

}

Prior to collection of system gestures, the InkPicture object, mInkPicture registers the event handler.

' register the SystemGesture event handler 
AddHandler mInkPicture.SystemGesture, New InkCollectorSystemGestureEventHandler(AddressOf Event_OnSystemGesture)
// register the SystemGesture event handler
mInkPicture.SystemGesture += new InkCollectorSystemGestureEventHandler(Event_OnSystemGesture);

Platforms

Windows 7, Windows Vista, Windows Server 2008 R2, Windows Server 2008

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.0

See Also

Reference

InkPicture Class

InkPicture Members

Microsoft.Ink Namespace

Cursor

InkCollectorSystemGestureEventArgs

SystemGesture

Other Resources

Using Gestures