RealTimeStylus.SetDesiredPacketDescription-Methode
Legt das Interesse des RealTimeStylus-Objekts anhand von Aspekten des Pakets fest, das in einem Tablettkontext erfasst wurde.
Namespace: Microsoft.StylusInput
Assembly: Microsoft.Ink (in Microsoft.Ink.dll)
Syntax
'Declaration
Public Sub SetDesiredPacketDescription ( _
value As Guid() _
)
'Usage
Dim instance As RealTimeStylus
Dim value As Guid()
instance.SetDesiredPacketDescription(value)
public void SetDesiredPacketDescription(
Guid[] value
)
public:
void SetDesiredPacketDescription(
array<Guid>^ value
)
public void SetDesiredPacketDescription(
Guid[] value
)
public function SetDesiredPacketDescription(
value : Guid[]
)
Parameter
- value
Typ: array<System.Guid[]
Die GUIDs (Globally unique identifiers) für die Paketeigenschaften, an denen das RealTimeStylus-Objekt Interesse hat.
Hinweise
Verwenden Sie diese Methode, um das Interesse des RealTimeStylus-Objekts an einem Satz von Paketeigenschaften festzulegen. 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 Tablet-Objekt erfasst, gibt das RealTimeStylus-Objekt nur die Paketdaten 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 das Erfassen von Freihanddaten mithilfe des RealTimeStylus-Objekts finden Sie unter Accessing and Manipulating Stylus Input.
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.
Diese Methode löst unter den folgenden Bedingungen eine Ausnahme aus.
Das RealTimeStylus-Objekt ist freigegeben.
Das RealTimeStylus-Objekt wurde mithilfe des RealTimeStylus()-Konstruktors erstellt.
Das RealTimeStylus-Objekt ist aktiviert.
Der value-Parameter ist nullNULL-Verweis (Nothing in Visual Basic) (Nothing in Visual Basic .NET) oder enthält ein leeres Array.
Beispiele
Dieses Microsoft Visual C# .NET-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. Wenn das RealTimeStylus-Objekt aktiviert ist oder keine der GUIDs der Paketeigenschaft im Formular überprüft wird, wird der Ereignishandler beendet. Andernfalls ruft der Ereignishandler die SetDesiredPacketDescription-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 SetDesiredPacketDescription menu item's Click event handler
private void theMenuItemSetDesiredPacketDescription_Click(object sender,
System.EventArgs e)
{
// Can not call this method while the RealTimeStylus is enabled.
if (this.thePrimaryRealTimeStylus.Enabled)
{
MessageBox.Show("The SetDesiredPacketDescription method of the RealTimeStylus can only be called while the RealTimeStylus is disabled.");
return;
}
// Create an array of GUIDs from the checked packet properties.
ArrayList result = new ArrayList();
// ...
// Can not pass an empty array to the SetDesiredPacketDescription method.
if (0 == result.Count)
{
this.theTextBox.Text = "No PacketProperty GUID's checked. The desired packet property's of the RealTimeStylus have not been changed.";
return;
}
// Set the desired packet properties.
Guid[] theGuids = (Guid[])result.ToArray(typeof(Guid));
this.thePrimaryRealTimeStylus.SetDesiredPacketDescription(theGuids);
this.theTextBox.Text = "The desired packet property's of the RealTimeStylus have been changed.";
}
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.
Versionsinformationen
.NET Framework
Unterstützt in: 3.0