IStylusSyncPlugin.DataInterest Property

  • Article

IStylusSyncPlugin.DataInterest Property

Used to define the set of data notifications that the plug-in requires.

Definition

Visual Basic .NET Public ReadOnly Property DataInterest As DataInterestMask
C# public DataInterestMask DataInterest { get; }
Managed C++ public: __property DataInterestMask* get_DataInterest();

Property Value

Microsoft.StylusInput.DataInterestMask. A bit mask that defines the set of data notifications.

This property is read-only. This property has no default value.

AllStylusData-1 Indicates the plug-in wishes to receive notifications for all data.
Error1 Occurs when an error has occurred and has been added to the input queue. See Error.
RealTimeStylusEnabled2 Occurs when the parent instance of the RealTimeStylus class has been enabled. See RealTimeStylusEnabled.
RealTimeStylusDisabled4 Occurs when the parent instance of the RealTimeStylus class has been disabled. See RealTimeStylusDisabled.
StylusInRange16 Occurs when the Stylus is in range of the digitizer. See StylusInRange.
InAirPackets32 Occurs when the Stylus is in range of the digitizer and moving, but not on the digitizer. See InAirPackets.
StylusOutOfRange64 Occurs when the Stylus is out of range of the digitizer. See StylusOutOfRange.
StylusDown128 Occurs when the stylus contacts the digitizer. See StylusDown.
Packets256 Occurs when the stylus moves along the digitizer while in contact. See Packets.
StylusUp512 Occurs when the stylus breaks physical contact with the digitizer. See StylusUp.
StylusButtonUp1024 Occurs when a stylus button has been released. See StylusButtonUp.
StylusButtonDown2048 Occurs when a stylus button is pressed. See StylusButtonDown.
SystemGesture4096 Occurs when a System Gestures is detected. See SystemGesture.
TabletAdded8192 Occurs when a new Tablet device is detected by the system. See TabletAdded.
TabletRemoved16384 Occurs when a Tablet device is removed from the system. See TabletRemoved
CustomStylusDataAdded32768 Occurs when a plug-in adds data to a queue. See CustomStylusDataAdded.
DefaultStylusData37766 Indicates plug-in wishes to receive the default stylus data: RealTimeStylusEnabled, RealTimeStylusDisabled, StylusDown, Packets, StylusUp, SystemGesture, and CustomStylusDataAdded.

Examples

[C#]

This C# example shows the implentation of the DataInterest in a plug-in. This plug-in indicates the need to receive notifications for Packets and Error.

public DataInterestMask DataInterest
{
    get
    {
        return DataInterestMask.Packets |
               DataInterestMask.Error;
    }
}

See Also