InkEdit.GetGestureStatus Method

Article
10/19/2012

Returns a value that indicates whether the InkEdit object has interest in a particular application gesture.

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

Syntax

'Declaration
Public Function GetGestureStatus ( _
    gesture As ApplicationGesture _
) As Boolean
'Usage
Dim instance As InkEdit 
Dim gesture As ApplicationGesture 
Dim returnValue As Boolean 

returnValue = instance.GetGestureStatus(gesture)

public bool GetGestureStatus(
    ApplicationGesture gesture
)

public:
bool GetGestureStatus(
    ApplicationGesture gesture
)

public function GetGestureStatus(
    gesture : ApplicationGesture
) : boolean

Parameters

gesture
Type: Microsoft.Ink.ApplicationGesture

A member of the ApplicationGesture enumeration that represents the gesture to query about.

Return Value

Type: System.Boolean
Whether the InkEdit control has interest in a particular application gesture.

Value	Meaning
true	The InkEdit control has interest in the gesture. The Gesture event is raised when the gesture is recognized.
false	The InkEdit control has no interest in the gesture.

Remarks

This method throws an exception if the gesture parameter is set to ApplicationGesture.

To set the interest of the InkEdit control in a particular gesture, call the SetGestureStatus method.

Note

By default, the InkEdit control has interest in the following application gestures:

Examples

This C# example creates an ArrayList that contains all application gestures for which an InkEdit control, theInkEdit, has interest.

using Microsoft.Ink;
// . . .
// Return an array of all of the ApplicationGestures that
// have their status set to true on the InkEdit control.
private ApplicationGesture [] GetSetAppGestures(InkEdit theInkEdit)
{
    ArrayList result = new ArrayList();
    ApplicationGesture test = ApplicationGesture.NoGesture;
    Array gestureArray = System.Enum.GetValues(test.GetType());
    foreach (ApplicationGesture theGesture in gestureArray)
    {
        // ApplicationGesture.AllGestures is not a meaningful 
        // gesture to pass to GetGestureStatus()
        if (theGesture != ApplicationGesture.AllGestures && 
            theInkEdit.GetGestureStatus(theGesture))
        {
            result.Add(theGesture);
        }
    }
    return (ApplicationGesture[])result.ToArray(typeof(ApplicationGesture));
}

This Microsoft® Visual Basic® .NET example creates an ArrayList that contains all application gestures for which an InkEdit control, theInkEdit, has interest.

Imports Microsoft.Ink
' . . .
' Return an array of all of the ApplicationGestures that
' have their status set to true on the InkEdit control.
Private Function GetSetAppGestures(ByVal theInkEdit As InkEdit) _
    As ApplicationGesture()
    Dim result As New ArrayList()
    Dim test As ApplicationGesture = ApplicationGesture.NoGesture
    Dim theGestures As Array = System.Enum.GetValues(test.GetType())
    Dim theGesture As ApplicationGesture
    For Each theGesture In theGestures
        ' ApplicationGesture.AllGestures is not a meaningful 
        ' gesture to pass to GetGestureStatus()
        If (Not theGesture.Equals(ApplicationGesture.AllGestures)) AndAlso _
            theInkCollector.GetGestureStatus(theGesture) Then
            result.Add(theGesture)
        End If
    Next
    Return CType(result.ToArray(test.GetType()), ApplicationGesture())
End Function

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

Share via