RealTimeStylus.AddCustomStylusDataToQueue, méthode

Article
11/05/2008

Mise à jour : November 2007

Ajoute des données personnalisées à une file d'attente de l'objet RealTimeStylus.

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

Syntaxe

'Déclaration
Public Sub AddCustomStylusDataToQueue ( _
    queue As StylusQueues, _
    guid As Guid, _
    data As Object _
)
'Utilisation
Dim instance As RealTimeStylus
Dim queue As StylusQueues
Dim guid As Guid
Dim data As Object

instance.AddCustomStylusDataToQueue(queue, _
    guid, data)

public void AddCustomStylusDataToQueue(
    StylusQueues queue,
    Guid guid,
    Object data
)

public:
void AddCustomStylusDataToQueue(
    StylusQueues queue, 
    Guid guid, 
    Object^ data
)

public void AddCustomStylusDataToQueue(
    StylusQueues queue,
    Guid guid,
    Object data
)

public function AddCustomStylusDataToQueue(
    queue : StylusQueues, 
    guid : Guid, 
    data : Object
)

Paramètres

queue
Type : Microsoft.StylusInput.StylusQueues
Une des valeurs StylusQueues qui spécifie la file d'attente et l'emplacement dans la file d'attente dans laquelle ajouter les données personnalisées.

guid
Type : System.Guid
Identificateur global unique (GUID) qui identifie le type de données personnalisées ajoutées.

data
Type : System.Object
Données personnalisées à ajouter à la file d'attente.

Notes

Cette méthode vous permet d'étendre les fonctionnalités de l'objet RealTimeStylus en ajoutant des informations personnalisées à la file d'attente de l'objet RealTimeStylus. Ces informations sont ajoutées comme un objet CustomStylusData. Cette méthode permet d'implémenter la sélection et l'effacement de votre objet RealTimeStylus en créant des données personnalisées pour entrer et quitter les modes de sélection et d'effacement.

Vous pouvez ajouter des données de stylet personnalisées aux files d'attente de l'objet RealTimeStylus, StylusQueues, dans l'un des trois emplacements à l'aide de l'énumération.

Lorsque le paramètre queue a la valeur Input, les données personnalisées sont ajoutées à la file d'attente d'entrée de l'objet RealTimeStylus et envoyées à la collection de plug-in synchrone avant les nouvelles données du flux de données du stylet.

Lorsque le paramètre queue a la valeur Output, les données personnalisées sont ajoutées à la file d'attente de sortie de l'objet RealTimeStylus après le traitement des données par la collection de plug-in synchrone.

Lorsque le paramètre queue a la valeur OutputImmediate, les données personnalisées sont ajoutées à la file d'attente de sortie de l'objet RealTimeStylus avant le traitement des données par la collection de plug-in synchrone.

Dans chacun des cas précédents, les données ajoutées par les plug-in suivants dans la collection de plug-in synchrone le sont après celles ajoutées par les plug-in précédents.

Les données de stylet personnalisées sont ajoutées à la file d'attente en tant qu'objet CustomStylusData et les plug-in reçoivent ces données via leur méthode IStylusSyncPlugin.CustomStylusDataAdded ou IStylusAsyncPlugin.CustomStylusDataAdded.

Lorsqu'un objet non présent sur le thread de l'objet RealTimeStylus appelle la méthode AddCustomStylusDataToQueue, la relation entre les données personnalisées sur les files d'attente et les paquets traités par l'objet RealTimeStylus est indéterminée.

Attention :
L'ajout de données personnalisées à la file d'attente d'entrée suite à la réception de données personnalisées par un objet qui implémente l'interface IStylusSyncPlugin peut créer une boucle infinie sur le thread de l'objet RealTimeStylus.

Pour plus d'informations sur l'ordre d'ajout des données (y compris les illustrations) dans les files d'attente, consultez les rubriques d'aide conceptuelle dans Accessing and Manipulating Stylus Input.

La liste suivante décrit les conditions requises pour que cette méthode lève une exception.

L'objet RealTimeStylus est supprimé.
Le paramètre data a la valeur null (Nothing en Visual Basic .NET).
L'objet RealTimeStylus est désactivé.
Aucun plug-in approprié n'est attaché à l'objet RealTimeStylus pour recevoir des informations de la file d'attente spécifiée.
Le paramètre guid a la valeur GUID associée au DynamicRenderer ou à la classe GestureRecognizer.

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.