GestureAlternate.Id Property

Article
10/07/2012

Gets the unique identifier of the application gesture that occured.

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

Syntax

'Declaration
Public ReadOnly Property Id As ApplicationGesture
'Usage
Dim instance As GestureAlternate 
Dim value As ApplicationGesture 

value = instance.Id

public ApplicationGesture Id { get; }

public:
property ApplicationGesture Id {
    ApplicationGesture get ();
}

public function get Id () : ApplicationGesture

Property Value

Type: Microsoft.Ink.ApplicationGesture
A member of the ApplicationGesture enumeration that identifies the application gesture that occured.

Examples

This Microsoft Visual C# .NET example is a snippet from the implementation of the IStylusAsyncPlugin interface's CustomStylusDataAdded method. The form that implements the IStylusAsyncPlugin interface contains a TextBox object, theTextBox. The CustomStylusDataAdded method checks for custom stylus data from the GestureRecognizer object and displays information about any gesture or gestures that the GestureRecognizer object recognized.

using Microsoft.Ink;
using Microsoft.StylusInput;
using Microsoft.StylusInput.PluginData;

// ...

// Declare the RealTimeStylus objects, the GestureRecognizer plugin,
// and the DynamicRenderer plug-in.
private Microsoft.StylusInput.RealTimeStylus thePrimaryRealTimeStylus = null;
private Microsoft.StylusInput.RealTimeStylus theSecondaryRealTimeStylus = null;
private Microsoft.StylusInput.GestureRecognizer theGestureRecognizer = null;
private Microsoft.StylusInput.DynamicRenderer theDynamicRenderer = null;

// ...

// Informs the implementing object that user data is available.
public void CustomStylusDataAdded(RealTimeStylus sender, CustomStylusData data)
{
    // We can identify the kind of custom data via either the Guid or Type.
    // For the purpose of this demonstration we will validate both just to be safe.
    // For other scenarios either approach is valid.
    if (data.CustomDataId == GestureRecognizer.GestureRecognitionDataGuid)
    {
        // Cast the custom stylus data to gesture recognition data.
        GestureRecognitionData theData = data.Data as GestureRecognitionData;

        // If there is data in the notification, then display the information
        // for all of the gestures recognized.
        if (theData != null && theData.Count > 0)
        {
            this.theTextBox.Text = "GestureRecognitionData:" + Environment.NewLine;
            foreach (GestureAlternate theGesture in theData)
            {
                this.theTextBox.Text += string.Format(
                    "  Gesture {0,-10}, Confidence {1,-8}, Count {2}."
                    + Environment.NewLine, theGesture.Id,
                    theGesture.Confidence, theGesture.StrokeCount);
            }
            this.theTextBox.Text += Environment.NewLine;
        }
    }
}

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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