RealTimeStylus.SetDesiredPacketDescription, méthode

Article
11/05/2008

Mise à jour : November 2007

Définit l'intérêt de l'objet RealTimeStylus concernant le paquet collecté dans un contexte de la tablette.

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

Syntaxe

'Déclaration
Public Sub SetDesiredPacketDescription ( _
    value As Guid() _
)
'Utilisation
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[]
)

Paramètres

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

Notes

Utilisez cette méthode pour définir l'intérêt de l'objet RealTimeStylus dans un ensemble de propriétés de paquet. 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'un objet Tablet, 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 laquelle l'entrée manuscrite est collectée. Pour plus d'informations sur la collecte d'entrée manuscrite à l'aide de l'objet RealTimeStylus, consultez Accessing and Manipulating Stylus Input.

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).

Cette méthode lève une exception dans les conditions suivantes.

L'objet RealTimeStylus est supprimé.
L'objet RealTimeStylus est créé avec le constructeur RealTimeStylus().
L'objet RealTimeStylus est activé.
Le paramètre value a la valeur nullune référence null (Nothing en Visual Basic) (Nothing en Visual Basic .NET) ou contient un tableau vide.

Exemples

Cet exemple Microsoft Visual C# .NET est un extrait de code du 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. Si l'objet RealTimeStylus est activé ou si aucun GUID des propriétés de paquet n'est vérifié sur le formulaire, le gestionnaire d'événements se ferme. Sinon, le gestionnaire d'événements appelle la méthode SetDesiredPacketDescription 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 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.";
}

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.