RealTimeStylus Class

RealTimeStylus Class

Handles the stylus packet data from a digitizer in real time. This class cannot be inherited.

Definition

Visual Basic .NET	NotInheritable Public Class RealTimeStylus Inherits Object Implements IDisposable, IStylusAsyncPlugin
C#	public sealed class RealTimeStylus : Object, IDisposable, IStylusAsyncPlugin
Managed C++	public __gc __sealed class RealTimeStylus : public Object, IDisposable, IStylusAsyncPlugin

Members Table

The following table lists the members exposed by the object.

Methods

Method	Description
AddCustomStylusDataToQueue	Adds custom data to a queue of the RealTimeStylus object.
ClearStylusQueues	Clears the stylus queues.
Dispose	Releases all resources used by the object.
Equals	Determines whether two Object instances are equal. Inherited from Object .
Finalize	Frees the resources of the current RealTimeStylus object before it is reclaimed by the garbage collector.
GetDesiredPacketDescription	Gets the RealTimeStylus object's interest in aspects of the packets collected on a tablet context.
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 .
GetStyluses	Returns the array of Stylus objects encountered by the RealTimeStylus.
GetTabletContextIDFromTablet	Gets the tablet context identifer object that is associated with a given Tablet object.
GetTabletFromTabletContextID	Gets the Tablet object that is associated with a given tablet context identifier.
GetTabletPropertyDescriptionCollection	Returns the TabletPropertyDescriptionCollection collection that is associated with a given tablet context identifier.
GetType	Gets the Type of the current instance. Inherited from Object .
IStylusAsyncPlugin.CustomStylusDataAdded	This method supports the RealTimeStylus infrastructure and is not intended to be used directly from your code.
IStylusAsyncPlugin.Error	This method supports the RealTimeStylus infrastructure and is not intended to be used directly from your code.
IStylusAsyncPlugin.InAirPackets	This method supports the RealTimeStylus infrastructure and is not intended to be used directly from your code.
IStylusAsyncPlugin.Packets	This method supports the RealTimeStylus infrastructure and is not intended to be used directly from your code.
IStylusAsyncPlugin.RealTimeStylusDisabled	This method supports the RealTimeStylus infrastructure and is not intended to be used directly from your code.
IStylusAsyncPlugin.RealTimeStylusEnabled	This method supports the RealTimeStylus infrastructure and is not intended to be used directly from your code.
IStylusAsyncPlugin.StylusButtonDown	This method supports the RealTimeStylus infrastructure and is not intended to be used directly from your code.
IStylusAsyncPlugin.StylusButtonUp	This method supports the RealTimeStylus infrastructure and is not intended to be used directly from your code.
IStylusAsyncPlugin.StylusDown	This method supports the RealTimeStylus infrastructure and is not intended to be used directly from your code.
IStylusAsyncPlugin.StylusInRange	This method supports the RealTimeStylus infrastructure and is not intended to be used directly from your code.
IStylusAsyncPlugin.StylusOutOfRange	This method supports the RealTimeStylus infrastructure and is not intended to be used directly from your code.
IStylusAsyncPlugin.StylusUp	This method supports the RealTimeStylus infrastructure and is not intended to be used directly from your code.
IStylusAsyncPlugin.SystemGesture	This method supports the RealTimeStylus infrastructure and is not intended to be used directly from your code.
IStylusAsyncPlugin.TabletAdded	This method supports the RealTimeStylus infrastructure and is not intended to be used directly from your code.
IStylusAsyncPlugin.TabletRemoved	This method supports the RealTimeStylus infrastructure and is not intended to be used directly from your code.
MemberwiseClone	Creates a shallow copy of the current Object . Inherited from Object .
RealTimeStylus	Creates a RealTimeStylus object.
ReferenceEquals	Determines whether the specified Object instances are the same instance. Inherited from Object .
SetDesiredPacketDescription	Sets the RealTimeStylus object's interest in aspects of the packets collected on a tablet context.
ToString	Returns a String that represents the current Object . Inherited from Object .

Properties

Property	Description
AsyncPluginCollection	Gets the collection of IStylusSyncPlugin plug-ins that receive tablet pen data from the RealTimeStylus object.
Enabled	Gets or sets a value which indicates whether the collection of stylus data is enabled.
SyncPluginCollection	Gets the collection of IStylusAsyncPlugin plug-ins that receive tablet pen data from the RealTimeStylus object.
WindowInputRectangle	Gets or sets the input rectangle for the RealTimeStylus object.

Inheritance Hierarchy

Object

RealTimeStylus

Remarks

This object is used to provide access to the stylus events coming from the hardware. It controls the flow of ink going to an ink collector.

Use this object to intercept the stylus packet stream. If you do not need to interact with the packet stream in real time before it gets to the ink collecting object, then use the InkCollector, the InkOverlay, or the InkPicture object instead of this object.

Note: You cannot attach the RealTimeStylus object to a window or control in a different application domain.

Security Alert: If using under partial trust, this class and all its methods require UIPermissionWindow.SafeTopLevelWindows and SecurityPermissionFlag.UnmanagedCode permissions. See Security And Trust for more information.

Class Information

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

See Also

• Accessing and Manipulating Pen Input
• IStylusSyncPlugin Interface
• IStylusAsyncPlugin Interface