RealTimeStylus.GetDesiredPacketDescription-Methode

Artikel
11/26/2008

Gibt ein Array von Werten zurück, die das im Tablettkontext erfasste Paket angeben, an dem das RealTimeStylus-Objekt Interesse hat.

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

Syntax

'Declaration
Public Function GetDesiredPacketDescription As Guid()
'Usage
Dim instance As RealTimeStylus
Dim returnValue As Guid()

returnValue = instance.GetDesiredPacketDescription()

public Guid[] GetDesiredPacketDescription()

public:
array<Guid>^ GetDesiredPacketDescription()

public Guid[] GetDesiredPacketDescription()

public function GetDesiredPacketDescription() : Guid[]

Rückgabewert

Typ: array<System.Guid[]
Gibt die GUIDs (Globally unique identifiers) für die Paketeigenschaften zurück, an denen das RealTimeStylus-Objekt interessiert ist.

Hinweise

Verwenden Sie diese Methode, um ein Array von Paketeigenschaften abzurufen, an denen das RealTimeStylus-Objekt Interesse hat. Die Paketeigenschaften werden durch ein Array von GUIDs dargestellt. Das PacketProperty-Objekt definiert die GUIDs der standardmäßigen Paketeigenschaften. Allerdings können auch andere GUIDs verwendet werden.

Wenn das RealTimeStylus-Objekt Freihandeingaben von einem Tablett erfasst, gibt das RealTimeStylus-Objekt Paketdaten nur für die Paketeigenschaften zurück, für die Sie Interesse festgelegt haben, wie anhand des Rückgabewerts der GetDesiredPacketDescription-Methode veranschaulicht, und die außerdem durch das Tablett unterstützt werden, auf dem die Freihandeingabe erfasst wird. Weitere Informationen über die Behandlung von Freihanddaten durch das RealTimeStylus-Objekt finden Sie unter Ink-Collection Plug-ins.

Die SetDesiredPacketDescription-Methode kann nur aufgerufen werden, solange das RealTimeStylus-Objekt deaktiviert ist. Aufrufe der SetDesiredPacketDescription-Methode werden jedoch sofort im Rückgabewert der GetDesiredPacketDescription-Methode wiedergegeben.

In der folgenden Liste wird beschrieben, wie das RealTimeStylus-Objekt die Reihenfolge der GUIDs der Paketeigenschaften festlegt.

Die GUIDs von PacketProperty.X- und PacketProperty.Y- werden durch die GetDesiredPacketDescription-Methode immer an den ersten beiden Positionen im Array zurückgegeben, ungeachtet dessen, ob sie im vorherigen Aufruf der SetDesiredPacketDescription-Methode angegeben wurden.
Wird die PacketProperty.PacketStatus-GUID im Aufruf der SetDesiredPacketDescription-Methode angegeben, wird die PacketProperty.PacketStatus-GUID immer an der letzten Position im Array durch die GetDesiredPacketDescription-Methode angegeben.
Werden GUIDs in einem Aufruf der SetDesiredPacketDescription-Methode mehrfach aufgerufen, tritt eine GUID in dem durch die GetDesiredPacketDescription-Methode zurückgegebenen Array nur einmal auf.
Die GetDesiredPacketDescription-Methode gibt standardmäßig die GUIDs PacketProperty.X, PacketProperty.Y, und PacketProperty.NormalPressure zurück.

Wenn Sie z. B. die SetDesiredPacketDescription-Methode mit (a, b, a, PacketStatus, b, c, d) aufrufen, gibt ein Aufruf der GetDesiredPacketDescription-Methode (X, Y, a, b, c, d, PacketStatus) zurück.

Beispiele

Dieses C#-Beispiel ist ein Ausschnitt aus dem Click-Ereignishandler eines Menüelements. Das Menü ist Teil eines Formulars, für das das TextBox-Objekt theTextBox definiert ist. Der Ereignishandler ruft die GetDesiredPacketDescription-Methode des RealTimeStylus-Objekts auf.

using Microsoft.Ink;
using Microsoft.StylusInput;
using Microsoft.StylusInput.PluginData;

// ...

// Declare the RealTimeStylus objects, the GestureRecognizer plugin,
// and the DynamicRenderer plug-in.
private Microsoft.StylusInput.RealTimeStylus thePrimaryRealTimeStylus = null;
private Microsoft.StylusInput.RealTimeStylus theSecondaryRealTimeStylus = null;
private Microsoft.StylusInput.GestureRecognizer theGestureRecognizer = null;
private Microsoft.StylusInput.DynamicRenderer theDynamicRenderer = null;

// ...

// The GetDesiredPacketDescription menu item's ClickEventHandler
private void theMenuItemGetDesiredPacketDescription_Click(object sender,
    System.EventArgs e)
{
    this.theTextBox.Text = "DesiredPacketDescription = " + Environment.NewLine;
    foreach (Guid theGuid in this.thePrimaryRealTimeStylus.GetDesiredPacketDescription())
    {
        this.theTextBox.Text += string.Format("  {0}" + Environment.NewLine,
            this.GetPacketPropertyNameFromGuid(theGuid));
    }
}

Plattformen

Windows Vista, Windows XP SP2, Windows Server 2003

.NET Framework und .NET Compact Framework unterstützen nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen für .NET Framework.