PacketsData Class

PacketsData Class

Passed in the IStylusSyncPlugin.Packets and IStylusAsyncPlugin.Packets methods when packets are detected.

Definition

Visual Basic .NET	NotInheritable Public Class PacketsData Inherits StylusDataBase
C#	public sealed class PacketsData : StylusDataBase
Managed C++	public __gc __sealed class PacketsData : public StylusDataBase

Members Table

The following table lists the members exposed by the object.

Methods

Method	Description
Equals	Determines whether two Object instances are equal. Inherited from Object .
Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. Inherited from Object .
GetData	Returns the packet data. Inherited from StylusDataBase.
GetEnumerator	Returns the System.Collections.IEnumerator interface used to iterate through the data. Inherited from StylusDataBase.
GetHashCode	Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. Inherited from Object .
GetType	Gets the Type of the current instance. Inherited from Object .
MemberwiseClone	Creates a shallow copy of the current Object . Inherited from Object .
PacketsData	Creates a PacketsData object.
ReferenceEquals	Determines whether the specified Object instances are the same instance. Inherited from Object .
SetData	Replaces the packet data with the data argument Inherited from StylusDataBase.
ToString	Returns a String that represents the current Object . Inherited from Object .
VerifyPacketData	Packet data validation called when the object is initialized. Inherited from StylusDataBase.

Properties

Property	Description
Count	Returns the length of the packet data. Inherited from StylusDataBase.
Item	Gets the item specified by the index within the collection. Inherited from StylusDataBase.
PacketPropertyCount	Gets the number of packets contained in the plug-in data object. Inherited from StylusDataBase.
Stylus	Gets information about the tablet pen at the time the associated data is generated. Inherited from StylusDataBase.

Inheritance Hierarchy

Object

StylusDataBase

PacketsData

Remarks

You can create new instances of the object and add it to a RealTimeStylus queue using the AddCustomStylusDataToQueue method.

You can modify the packet data of this notification by calling the SetData method.

Note: Calling the SetData method with its value property set to null (Nothing in Microsoft® Visual Basic® .NET) allows you to cancel the notification. This is useful when you want to cancel packets from within a plug-in. Calling the SetData method with its value property set to the empty Int32 array does not cancel the packet notification but does set the Count property to 0.

Class Information

Namespace	Microsoft.StylusInput.PluginData
Assembly	Microsoft.Ink (microsoft.ink.dll)
Strong Name	Microsoft.Ink, Version=1.7.4009.0, Culture=neutral, PublicKeyToken=a2870d9cc4d021c8