Share via


IStylusSyncPlugin.InAirPackets Method

Notifies the object implementing the IStylusSyncPlugin interface that the stylus is moving above the digitizer.

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

Syntax

'Declaration
Sub InAirPackets ( _
    sender As RealTimeStylus, _
    data As InAirPacketsData _
)
'Usage
Dim instance As IStylusSyncPlugin 
Dim sender As RealTimeStylus 
Dim data As InAirPacketsData

instance.InAirPackets(sender, data)
void InAirPackets(
    RealTimeStylus sender,
    InAirPacketsData data
)
void InAirPackets(
    RealTimeStylus^ sender, 
    InAirPacketsData^ data
)
function InAirPackets(
    sender : RealTimeStylus, 
    data : InAirPacketsData
)

Parameters

Remarks

You can modify the packet data by calling the inherited SetData method of the InAirPacketsData object contained in the data parameter.

Note

An ArgumentException exception is thrown by the SetData method if the length of the array in the value parameter is not a multiple of the value of the inherited PacketPropertyCount property.

You can cancel the in-air packets by calling the SetData method with the value parameter set to null (Nothing in Microsoft Visual Basic .NET).

Examples

This C# example alerts the developer to the number in-air packets received and the Stylus object that generated the packets.

public void InAirPackets(RealTimeStylus sender, InAirPacketsData data)
{ 
  Debug.Assert(false, "In-air packets reveived.", "Received " + data.Count.ToString() + 
                      " in-air packets from stylus " + data.Stylus.Id.ToString());
}

This Microsoft Visual Basic .NET example alerts the developer to the number in-air packets received and the Stylus object that generated the packets.

Public Sub InAirPackets(ByVal sender As RealTimeStylus, ByVal data As InAirPacketsData) _
  Implements IStylusSyncPlugin.InAirPackets
    Debug.Assert(False, "InAirPackets", "Received " & data.Count.ToString() & _
                                             " in-air packets from stylus " & _
                                             data.Stylus.Id.ToString())
End Sub 'InAirPackets

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

See Also

Reference

IStylusSyncPlugin Interface

IStylusSyncPlugin Members

Microsoft.StylusInput Namespace

RealTimeStylus

Microsoft.StylusInput.PluginData.InAirPacketsData