Stroke.GetPacketValuesByProperty Method (Guid)

Artículo
12/12/2007

Returns the data for a specified packet property for all of the packets in the Stroke object.

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

Syntax

'Declaration
Public Function GetPacketValuesByProperty ( _
    id As Guid _
) As Integer()
'Usage
Dim instance As Stroke
Dim id As Guid
Dim returnValue As Integer()

returnValue = instance.GetPacketValuesByProperty(id)

public int[] GetPacketValuesByProperty (
    Guid id
)

public:
array<int>^ GetPacketValuesByProperty (
    Guid id
)

public int[] GetPacketValuesByProperty (
    Guid id
)

public function GetPacketValuesByProperty (
    id : Guid
) : int[]

Not applicable.

Parameters

id
The Guid identifier from the PacketProperty object that is used to select which packet data is retrieved.

Return Value

Returns an array of signed 32-bit integers that specifies the value of the requested PacketProperty object for each point requested from the Stroke object.

Remarks

A specific packet property may not be available on a particular Stroke object. A Tablet PC may have more than one tablet for user input. The Tablets collection contains a list of all the tablets attached to the Tablet PC. Use the IsPacketPropertySupported method to determine if a particular packet property is supported by a specific Tablet object or by all the available tablets. Also, use the InkCollector.DesiredPacketDescription, InkOverlay.DesiredPacketDescription, or InkPicture.DesiredPacketDescription properties to control which packet properties are collected on new strokes.

Example

This C# example gets the ButtonPressure packet information for every point in the Stroke object, theStroke.

int[] theButtonPressureData =
    theStroke.GetPacketValuesByProperty(PacketProperty.ButtonPressure);

This Microsoft® Visual Basic® .NET example gets the ButtonPressure packet information for every point in the Stroke object, theStroke.

Dim theButtonPressureData() As Integer = _
    theStroke.GetPacketValuesByProperty(PacketProperty.ButtonPressure)

Platforms

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

Version Information

.NET Framework

Supported in: 3.0

Compartir a través de