InkEdit.SetGestureStatus Method

Artículo
12/12/2007

Sets whether or not the InkEdit control has interest in a known application gesture.

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

Syntax

'Declaration
Public Sub SetGestureStatus ( _
    gesture As ApplicationGesture, _
    listening As Boolean _
)
'Usage
Dim instance As InkEdit
Dim gesture As ApplicationGesture
Dim listening As Boolean

instance.SetGestureStatus(gesture, listening)

public void SetGestureStatus (
    ApplicationGesture gesture,
    bool listening
)

public:
void SetGestureStatus (
    ApplicationGesture gesture, 
    bool listening
)

public void SetGestureStatus (
    ApplicationGesture gesture, 
    boolean listening
)

public function SetGestureStatus (
    gesture : ApplicationGesture, 
    listening : boolean
)

Not applicable.

Parameters

gesture
A member of the ApplicationGesture enumeration, which indicates the gesture to set the status of.

listening
Whether or not the InkEdit control has interest in a known application gesture.

true if InkEdit control has interest in the application gesture; otherwise, false.

Remarks

The AllGestures value is not supported by the InkEdit control and returns an error; however, passing invalid gesture identifiers does not return an error.

This method should only be called if the InkEdit.Status property returns the InkEditStatus enumeration value, Idle.

Example

This C# example sets the interest status of each ApplicationGesture to false on the passed-in InkEdit control, theInkEdit.

using Microsoft.Ink;
// . . .
// Set all of the ApplicationGestures' status
// to false on the InkEdit control.
private void ClearAppGestures(InkEdit theInkEdit)
{
    ApplicationGesture test = ApplicationGesture.NoGesture;
    Array theGestures = System.Enum.GetValues(test.GetType());
    foreach (ApplicationGesture theGesture in theGestures)
    {
        theInkEdit.SetGestureStatus(theGesture, false);
    }
}

This Microsoft® Visual Basic® .NET example sets the interest status of each ApplicationGesture to false on the passed-in InkEdit control, theInkEdit.

Imports Microsoft.Ink
' . . .
' Set all of the ApplicationGestures' status
' to false on the InkEdit object.
Private Sub ClearAppGestures(ByVal theInkEdit As InkEdit)
    Dim test As ApplicationGesture = ApplicationGesture.NoGesture
    Dim theGestures As Array = System.Enum.GetValues(test.GetType())
    Dim theGesture As ApplicationGesture
    For Each theGesture In theGestures
        theInkEdit.SetGestureStatus(theGesture, False)
    Next
End Sub

Platforms

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

Version Information

.NET Framework

Supported in: 3.0

Compartir a través de