Tablet.IsPacketPropertySupported Method

Article
10/19/2012

Returns a value that indicates whether a PacketProperty field, identified with a globally unique identifier (GUID), is supported by this Tablet object.

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

Syntax

'Declaration
Public Function IsPacketPropertySupported ( _
    id As Guid _
) As Boolean
'Usage
Dim instance As Tablet 
Dim id As Guid 
Dim returnValue As Boolean 

returnValue = instance.IsPacketPropertySupported(id)

public bool IsPacketPropertySupported(
    Guid id
)

public:
bool IsPacketPropertySupported(
    Guid id
)

public function IsPacketPropertySupported(
    id : Guid
) : boolean

Parameters

id
Type: System.Guid

The Guid identifier for the PacketProperty that you are checking.

Return Value

Type: System.Boolean
Returns a value that indicates whether a PacketProperty field, identified with a globally unique identifier (GUID), is supported by this Tablet object.

Value	Meaning
true	The PacketProperty field is supported by this Tablet object.
false	The PacketProperty field is not supported by this Tablet object.

Remarks

This method determines if a Tablet object supports various fields of the PacketProperty class.

Note

This function can be re-entered if called within certain message handlers, causing unexpected results. Take care to avoid a reentrant call when handling any of the following messages: WM_ACTIVATE, WM_ACTIVATEAPP, WM_NCACTIVATE, WM_PAINT; WM_SYSCOMMAND if wParam is set to SC_HOTKEY or SC_TASKLIST; and WM_SYSKEYDOWN (when processing Alt-Tab or Alt-Esc key combinations). This is an issue with single-threaded apartment model applications.

Examples

This example reports which PacketProperty fields are available for the default Tablet object of the Tablets collection.

Private Function Report_Properties_DefaultTablet() As String 

    Dim SB As StringBuilder = New StringBuilder(1024)
    Dim defTablet As Tablet = New Tablets().DefaultTablet

    ' Generate a report on which PacketProperties are supported by the default tablet.
    SB.AppendLine("Packet Properties supported by the default tablet: " + defTablet.Name)

    If defTablet.IsPacketPropertySupported(PacketProperty.AltitudeOrientation) Then
        SB.AppendLine("AltitudeOrientation: YES")
    Else
        SB.AppendLine("AltitudeOrientation: NO")
    End If 

    If defTablet.IsPacketPropertySupported(PacketProperty.AzimuthOrientation) Then
        SB.AppendLine("AzimuthOrientation: YES")
    Else
        SB.AppendLine("AzimuthOrientation: NO")
    End If 

    If defTablet.IsPacketPropertySupported(PacketProperty.ButtonPressure) Then
        SB.AppendLine("ButtonPressure: YES")
    Else
        SB.AppendLine("ButtonPressure: NO")
    End If 

    If defTablet.IsPacketPropertySupported(PacketProperty.NormalPressure) Then
        SB.AppendLine("NormalPressure: YES")
    Else
        SB.AppendLine("NormalPressure: NO")
    End If 

    If defTablet.IsPacketPropertySupported(PacketProperty.PacketStatus) Then
        SB.AppendLine("PacketStatus: YES")
    Else
        SB.AppendLine("PacketStatus: NO")
    End If 

    If defTablet.IsPacketPropertySupported(PacketProperty.PitchRotation) Then
        SB.AppendLine("PitchRotation: YES")
    Else
        SB.AppendLine("PitchRotation: NO")
    End If 

    If defTablet.IsPacketPropertySupported(PacketProperty.RollRotation) Then
        SB.AppendLine("RollRotation: YES")
    Else
        SB.AppendLine("RollRotation: NO")
    End If 

    If defTablet.IsPacketPropertySupported(PacketProperty.SerialNumber) Then
        SB.AppendLine("SerialNumber: YES")
    Else
        SB.AppendLine("SerialNumber: NO")
    End If 

    If defTablet.IsPacketPropertySupported(PacketProperty.TangentPressure) Then
        SB.AppendLine("TangentPressure: YES")
    Else
        SB.AppendLine("TangentPressure: NO")
    End If 

    If defTablet.IsPacketPropertySupported(PacketProperty.TimerTick) Then
        SB.AppendLine("TimerTick: YES")
    Else
        SB.AppendLine("TimerTick: NO")
    End If 

    If defTablet.IsPacketPropertySupported(PacketProperty.TwistOrientation) Then
        SB.AppendLine("TwistOrientation: YES")
    Else
        SB.AppendLine("TwistOrientation: NO")
    End If 

    If defTablet.IsPacketPropertySupported(PacketProperty.X) Then
        SB.AppendLine("X: YES")
    Else
        SB.AppendLine("X: NO")
    End If 

    If defTablet.IsPacketPropertySupported(PacketProperty.XTiltOrientation) Then
        SB.AppendLine("XTiltOrientation: YES")
    Else
        SB.AppendLine("XTiltOrientation: NO")
    End If 

    If defTablet.IsPacketPropertySupported(PacketProperty.Y) Then
        SB.AppendLine("Y: YES")
    Else
        SB.AppendLine("Y: NO")
    End If 

    If defTablet.IsPacketPropertySupported(PacketProperty.YawRotation) Then
        SB.AppendLine("YawRotation: YES")
    Else
        SB.AppendLine("YawRotation: NO")
    End If 

    If defTablet.IsPacketPropertySupported(PacketProperty.YTiltOrientation) Then
        SB.AppendLine("YTiltOrientation: YES")
    Else
        SB.AppendLine("YTiltOrientation: NO")
    End If 

    If defTablet.IsPacketPropertySupported(PacketProperty.Z) Then
        SB.AppendLine("Z: YES")
    Else
        SB.AppendLine("Z: NO")
    End If 

    Return SB.ToString

End Function

public string Report_Properties_DefaultTablet()
{
    StringBuilder SB = new StringBuilder(1024);

    Tablet defTablet = new Tablets().DefaultTablet;
    // Generate a report on which PacketProperties are supported by the default tablet.
    SB.AppendLine("Packet Properties supported by the default tablet: " + defTablet.Name);
    SB.AppendLine("AltitudeOrientation: " + ((defTablet.IsPacketPropertySupported(PacketProperty.AltitudeOrientation)) ? "YES" : "NO"));
    SB.AppendLine("AzimuthOrientation: " + ((defTablet.IsPacketPropertySupported(PacketProperty.AzimuthOrientation)) ? "YES" : "NO"));
    SB.AppendLine("ButtonPressure: " + ((defTablet.IsPacketPropertySupported(PacketProperty.ButtonPressure)) ? "YES" : "NO"));
    SB.AppendLine("NormalPressure: " + ((defTablet.IsPacketPropertySupported(PacketProperty.NormalPressure)) ? "YES" : "NO"));
    SB.AppendLine("PacketStatus: " + ((defTablet.IsPacketPropertySupported(PacketProperty.PacketStatus)) ? "YES" : "NO"));
    SB.AppendLine("PitchRotation: " + ((defTablet.IsPacketPropertySupported(PacketProperty.PitchRotation)) ? "YES" : "NO"));
    SB.AppendLine("RollRotation: " + ((defTablet.IsPacketPropertySupported(PacketProperty.RollRotation)) ? "YES" : "NO"));
    SB.AppendLine("SerialNumber: " + ((defTablet.IsPacketPropertySupported(PacketProperty.SerialNumber)) ? "YES" : "NO"));
    SB.AppendLine("TangentPressure: " + ((defTablet.IsPacketPropertySupported(PacketProperty.TangentPressure)) ? "YES" : "NO"));
    SB.AppendLine("TimerTick: " + ((defTablet.IsPacketPropertySupported(PacketProperty.TimerTick)) ? "YES" : "NO"));
    SB.AppendLine("TwistOrientation: " + ((defTablet.IsPacketPropertySupported(PacketProperty.TwistOrientation)) ? "YES" : "NO"));
    SB.AppendLine("X: " + ((defTablet.IsPacketPropertySupported(PacketProperty.X)) ? "YES" : "NO"));
    SB.AppendLine("XTiltOrientation: " + ((defTablet.IsPacketPropertySupported(PacketProperty.XTiltOrientation)) ? "YES" : "NO"));
    SB.AppendLine("Y: " + ((defTablet.IsPacketPropertySupported(PacketProperty.Y)) ? "YES" : "NO"));
    SB.AppendLine("YawRotation: " + ((defTablet.IsPacketPropertySupported(PacketProperty.YawRotation)) ? "YES" : "NO"));
    SB.AppendLine("YTiltOrientation: " + ((defTablet.IsPacketPropertySupported(PacketProperty.YTiltOrientation)) ? "YES" : "NO"));
    SB.AppendLine("Z: " + ((defTablet.IsPacketPropertySupported(PacketProperty.Z)) ? "YES" : "NO"));
    return SB.ToString();
 }

Platforms

Windows 7, Windows Vista, Windows Server 2008 R2, Windows Server 2008

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

Share via