TabletPropertyMetrics Structure

Article
10/20/2012

Defines the range and resolution of a packet property.

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

Syntax

'Declaration
Public Structure TabletPropertyMetrics
'Usage
Dim instance As TabletPropertyMetrics

public struct TabletPropertyMetrics

public value class TabletPropertyMetrics

JScript supports the use of structures, but not the declaration of new ones.

Remarks

You create a TabletPropertyMetrics structure when you call either the Tablet.GetPropertyMetrics or Stroke.GetPacketDescriptionPropertyMetrics method.

Examples

In this example, each selected Stroke object of an InkOverlay object is modified so that each point of the second half of the stroke contains the maxium allowed NormalPressure packet value.

Using the GetPacketValuesByProperty method, the NormalPressure packet values for the second half of the Stroke object are obtained. The values are then set to the maximum allowed (as obtained via the GetPacketDescriptionPropertyMetrics method), and reapplied to the stroke using the SetPacketValuesByProperty method.

Try 
    For Each S As Stroke In mInkOverlay.Selection
        ' get the PacketProperty.NormalPressure metrics for the stroke 
        Dim metrics As TabletPropertyMetrics = S.GetPacketDescriptionPropertyMetrics(PacketProperty.NormalPressure)
        ' get the starting point 
        Dim startPt As Integer = S.PacketCount / 2
        ' get the NormalPressure values starting at startPt 
        Dim npValues() As Integer = S.GetPacketValuesByProperty(PacketProperty.NormalPressure, startPt)
        ' set the NormalPressure values to max 
        For k As Integer = 0 To npValues.Length - 1
            npValues(k) = metrics.Maximum
        Next 
        ' set the NormalPressure values starting at startPt
        S.SetPacketValuesByProperty(PacketProperty.NormalPressure, startPt, npValues)
    Next 

Catch ex As ArgumentException
    ' This exception will be raised if PacketProperty.NormalPressure is not supported 
    ' This will be the case if creating strokes with a mouse 
End Try

try
{
    foreach (Stroke S in mInkOverlay.Selection)
    {
        // get the PacketProperty.NormalPressure metrics for the stroke
        TabletPropertyMetrics metrics = S.GetPacketDescriptionPropertyMetrics(PacketProperty.NormalPressure);
        // get the starting point 
        int startPt = S.PacketCount / 2;
        // get the NormalPressure values starting at startPt 
        int[] npValues = S.GetPacketValuesByProperty(PacketProperty.NormalPressure, startPt);
        // set the NormalPressure values to max 
        for (int k = 0; k < npValues.Length; k++)
        {
            npValues[k] = metrics.Maximum;
        }
        // set the NormalPressure values starting at startPt
        S.SetPacketValuesByProperty(PacketProperty.NormalPressure, startPt, npValues);
    }
}
catch (ArgumentException)
{
    // This exception will be raised if PacketProperty.NormalPressure is not supported 
    // This will be the case if creating strokes with a mouse
}

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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