IStylusSyncPlugin.StylusUp Method
Notifies the implementing plug-in when the user raises the stylus off of the digitizer surface.
Assembly: Microsoft.Ink (in Microsoft.Ink.dll)
'Declaration Sub StylusUp ( _ sender As RealTimeStylus, _ data As StylusUpData _ ) 'Usage Dim instance As IStylusSyncPlugin Dim sender As RealTimeStylus Dim data As StylusUpData instance.StylusUp(sender, data)
Parameters
- sender
- Type: Microsoft.StylusInput.RealTimeStylus
The RealTimeStylus object that sent the notification.
- data
- Type: Microsoft.StylusInput.PluginData.StylusUpData
Information about the Stylus object associated with the notification.
You can modify the packet data by calling the inherited SetData method of the StylusUpData 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 equal to the value of the inherited PacketPropertyCount property. |
This C# example is excerpted from the RealTimeStylus Plug-in Sample. The example shows how to restrict pen input to a specified rectangle.
public void StylusUp(RealTimeStylus sender, StylusUpData data) { ModifyPacketData(data); } private void ModifyPacketData(StylusDataBase data) { // For each packet in the packet data, check whether // its x,y values fall outside of the specified rectangle. // If so, replace them with the nearest point that still // falls within the rectangle. for (int i = 0; i < data.Count ; i += data.PacketPropertyCount) { // packet data always has x followed by y followed by the rest int x = data[i]; int y = data[i+1]; // Constrain points to the input rectangle x = Math.Max(x, rectangle.Left); x = Math.Min(x, rectangle.Right); y = Math.Max(y, rectangle.Top); y = Math.Min(y, rectangle.Bottom); // If necessary, modify the x,y packet data if (x != data[i]) { data[i] = x; } if (y != data[i+1]) { data[i+1] = y; } } }
This Microsoft Visual Basic .NET example is excerpted from the RealTimeStylus Plug-in Sample. The example shows how to restrict pen input to a specified rectangle.
Public Sub StylusUp(ByVal sender As RealTimeStylus, ByVal data As StylusUpData) _ Implements IStylusSyncPlugin.StylusUp ModifyPacketData(data) End Sub 'StylusUp Private Sub ModifyPacketData(ByVal data As StylusDataBase) ' For each packet in the packet data, check whether ' its x,y values fall outside of the specified rectangle. ' If so, replace them with the nearest point that still ' falls within the rectangle. Dim i As Integer For i = 0 To data.Count - data.PacketPropertyCount Step data.PacketPropertyCount ' packet data always has x followed by y followed by the rest Dim x As Integer = data(i) Dim y As Integer = data((i + 1)) ' Constrain points to the input rectangle x = Math.Max(x, rectangle.Left) x = Math.Min(x, rectangle.Right) y = Math.Max(y, rectangle.Top) y = Math.Min(y, rectangle.Bottom) ' If necessary, modify the x,y packet data If x <> data(i) Then data(i) = x End If If y <> data((i + 1)) Then data((i + 1)) = y End If Next i End Sub 'ModifyPacketData
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.
Note: