InkCollectorNewInAirPacketsEventArgs.Cursor Property

Article
2012-10-20

Gets the Cursor object that generated the NewInAirPackets event.

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

Syntax

'Declaration
Public ReadOnly Property Cursor As Cursor
'Usage
Dim instance As InkCollectorNewInAirPacketsEventArgs 
Dim value As Cursor 

value = instance.Cursor

public Cursor Cursor { get; }

public:
property Cursor^ Cursor {
    Cursor^ get ();
}

public function get Cursor () : Cursor

Property Value

Type: Microsoft.Ink.Cursor
The object that generated the NewInAirPackets event.

Remarks

The Microsoft.Ink.Cursor class is not to be confused with System.Windows.Forms.Cursor class. Microsoft.Ink.Cursor represents general information about a tablet pointing and selecting device, usually a pen, while System.Windows.Forms.Cursor represents the image used to paint the mouse pointer.

Examples

In this example, an InkCollectorNewInAirPacketsEventHandler instance obtains the X and Y values of the last packet passed via the InkCollectorNewInAirPacketsEventArgs object. The X and Y values are always in the first two positions of the packet data.

Private Sub mInkObject_NewInAirPackets2(ByVal sender As Object, ByVal e As InkCollectorNewInAirPacketsEventArgs)
    Dim DescriptorsPerPacket As Integer = 0
    ' determine how many descriptors there are per packet 
    ' you could also obtain this value using: 
    '   e.PacketData.Length / e.PacketCount 
    ' but if you need to know which particular properties 
    ' are supported (beyond X and Y which are always placed first) 
    ' you will need to query e.Cursor.Tablet.IsPacketPropertySupported() 
    For Each G As Guid In mInkObject.DesiredPacketDescription
        If (e.Cursor.Tablet.IsPacketPropertySupported(G)) Then
            DescriptorsPerPacket += 1
        End If 
    Next 

    Dim LastX As Integer = e.PacketData(DescriptorsPerPacket * (e.PacketCount - 1))
    Dim LastY As Integer = e.PacketData((DescriptorsPerPacket * (e.PacketCount - 1)) + 1)
End Sub

private void mInkObject_NewInAirPackets2(object sender, InkCollectorNewInAirPacketsEventArgs e)
{
    int DescriptorsPerPacket = 0;
    // determine how many descriptors there are per packet 
    // you could also obtain this value using: 
    //   e.PacketData.Length / e.PacketCount 
    // but if you need to know which particular properties 
    // are supported (beyond X and Y which are always placed first) 
    // you will need to query e.Cursor.Tablet.IsPacketPropertySupported() 

    foreach (Guid G in mInkObject.DesiredPacketDescription)
    {
        if (e.Cursor.Tablet.IsPacketPropertySupported(G))
        {
            DescriptorsPerPacket++;
        }
    }

    int LastX = e.PacketData[DescriptorsPerPacket * (e.PacketCount - 1)];
    int LastY = e.PacketData[(DescriptorsPerPacket * (e.PacketCount - 1)) + 1];

}

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