RealTimeStylus.GetDesiredPacketDescription, méthode

Article
11/05/2008

Mise à jour : November 2007

Retourne un tableau de valeurs qui indiquent le paquet collecté sur un contexte de la tablette pour lequel l'objet RealTimeStylus a un intérêt.

Espace de noms : Microsoft.StylusInput
Assembly : Microsoft.Ink (dans Microsoft.Ink.dll)

Syntaxe

'Déclaration
Public Function GetDesiredPacketDescription As Guid()
'Utilisation
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[]

Valeur de retour

Type : array<System.Guid[]
Retourne les identificateurs globaux uniques (GUIDs) pour les propriétés de paquet auxquelles l'objet RealTimeStylus s'intéresse.

Notes

Utilisez cette méthode pour obtenir le tableau des propriétés de paquet auxquelles l'objet RealTimeStylus s'intéresse. Les propriétés de paquet sont représentées par un tableau de GUID. L'objet PacketProperty définit les GUID des propriétés de paquets standard. Toutefois, il est également possible d'utiliser d'autres GUID.

Lorsque l'objet RealTimeStylus collecte l'entrée manuscrite d'une tablette, l'objet RealTimeStylus retourne uniquement des données de paquet pour les propriétés de paquet pour lesquelles vous avez défini un intérêt (comme la valeur de retour de la méthode GetDesiredPacketDescription le représente) et qui sont prises en charge par le Tablet PC sur lequel l'entrée manuscrite est collectée. Pour plus d'informations sur la gestion des données d'entrée manuscrite par l'objet RealTimeStylus, consultez Ink-Collection Plug-ins.

La méthode SetDesiredPacketDescription ne peut être appelée que si l'objet RealTimeStylus est désactivé. Toutefois, les appels à la méthode SetDesiredPacketDescription sont immédiatement répercutés sur la valeur de retour de la méthode GetDesiredPacketDescription.

La liste suivante décrit comment l'objet RealTimeStylus trie les GUID des propriétés de paquet.

Les GUID PacketProperty.X et PacketProperty.Y sont toujours retournés en première ou deuxième position du tableau par la méthode GetDesiredPacketDescription, qu'ils aient été spécifiés ou non dans un appel antérieur à la méthode SetDesiredPacketDescription.
Si le GUID PacketProperty.PacketStatus est spécifié dans l'appel à la méthode SetDesiredPacketDescription, le GUID PacketProperty.PacketStatus est toujours retourné en dernière position du tableau par la méthode GetDesiredPacketDescription.
Si un GUID est spécifié plus d'une fois dans l'appel à la méthode SetDesiredPacketDescription, chaque GUID n'est présent qu'une fois dans le tableau retourné par la méthode GetDesiredPacketDescription.
Par défaut, la méthode GetDesiredPacketDescription retourne les GUID PacketProperty.X, PacketProperty.Y et PacketProperty.NormalPressure.

Par exemple, si vous appelez la méthode SetDesiredPacketDescription avec (a, b, a, PacketStatus, b, c, d), un appel à la méthode GetDesiredPacketDescription retourne (X, Y, a, b, c, d, PacketStatus).

Exemples

Cet exemple C# est un extrait d'un gestionnaire d'événements Click (page pouvant être en anglais) d'un élément de menu. Le menu fait partie d'un formulaire sur lequel un objet TextBox (page pouvant être en anglais), theTextBox, est défini. Le gestionnaire d'événements appelle la méthode GetDesiredPacketDescription de l'objet RealTimeStylus.

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));
    }
}

Plateformes

Windows Vista, Windows XP SP2, Windows Server 2003

Le .NET Framework et le .NET Compact Framework ne prennent pas en charge toutes les versions de chaque plateforme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise du .NET Framework.