RealTimeStylus.GetTabletContextIdFromTablet, méthode

Article
11/05/2008

Mise à jour : November 2007

Retourne l'identificateur du contexte du Tablet PC associé à un objet Tablet donné.

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

Syntaxe

'Déclaration
Public Function GetTabletContextIdFromTablet ( _
    tablet As Tablet _
) As Integer
'Utilisation
Dim instance As RealTimeStylus
Dim tablet As Tablet
Dim returnValue As Integer

returnValue = instance.GetTabletContextIdFromTablet(tablet)

public int GetTabletContextIdFromTablet(
    Tablet tablet
)

public:
int GetTabletContextIdFromTablet(
    Tablet^ tablet
)

public int GetTabletContextIdFromTablet(
    Tablet tablet
)

public function GetTabletContextIdFromTablet(
    tablet : Tablet
) : int

Paramètres

tablet
Type : Microsoft.Ink.Tablet
Objet Tablet.

Valeur de retour

Type : System.Int32
Identificateur du contexte du Tablet PC associé à un objet Tablet donné.

Notes

Remarque :
Un identificateur de contexte de la tablette est spécifique à un objet RealTimeStylus. Toutefois, deux objets RealTimeStylus peuvent avoir un identificateur de contexte différent pour le même objet Tablet. De plus, un identificateur de contexte de la tablette n'est valide que lorsqu'un objet RealTimeStylus est activé. Si un objet RealTimeStylus est désactivé puis réactivé, pour chaque objet Tablet, l'identificateur de contexte de la tablette peut changer entre la première et la seconde activation de l'objet RealTimeStylus.

Un identificateur de contexte de la tablette est spécifique à un objet RealTimeStylus. Toutefois, deux objets RealTimeStylus peuvent avoir un identificateur de contexte différent pour le même objet Tablet. De plus, un identificateur de contexte de la tablette n'est valide que lorsqu'un objet RealTimeStylus est activé. Si un objet RealTimeStylus est désactivé puis réactivé, pour chaque objet Tablet, l'identificateur de contexte de la tablette peut changer entre la première et la seconde activation de l'objet RealTimeStylus.

Cette méthode lève une exception lorsque le RealTimeStylus est désactivé ou supprimé, ou lorsque le paramètre tablet a la valeur null (Nothing en Visual Basic).

Remarque :
Cette fonction peut être exécutée à nouveau lorsqu'elle est appelée dans certains gestionnaires de messages et provoquer des résultats inattendus. Prenez soin d'éviter un appel réentrant lors de la gestion de l'un des messages suivants : WM_ACTIVATE, WM_ACTIVATEAPP, WM_NCACTIVATE, WM_PAINT; WM_SYSCOMMAND si wParam a la valeur SC_HOTKEY ou SC_TASKLIST, et WM_SYSKEYDOWN (lors de l'utilisation des raccourcis clavier Alt+Tab ou Alt+Echap). Cette opération pose problème dans les applications de modèle de thread unique cloisonné.

Cette fonction peut être exécutée à nouveau lorsqu'elle est appelée dans certains gestionnaires de messages et provoquer des résultats inattendus. Prenez soin d'éviter un appel réentrant lors de la gestion de l'un des messages suivants : WM_ACTIVATE, WM_ACTIVATEAPP, WM_NCACTIVATE, WM_PAINT; WM_SYSCOMMAND si wParam a la valeur SC_HOTKEY ou SC_TASKLIST, et WM_SYSKEYDOWN (lors de l'utilisation des raccourcis clavier Alt+Tab ou Alt+Echap). Cette opération pose problème dans les applications de modèle de thread unique cloisonné.

Exemples

Cet exemple C# est un extrait de code de l'implémentation de la méthode TabletAdded de l'interface IStylusAsyncPlugin. Le formulaire qui implémente l'interface IStylusAsyncPlugin contient un objet TextBox (page pouvant être en anglais), theTextBox. La méthode TabletAdded affiche des informations concernant le Tablet PC ajouté, appelle la méthode GetTabletContextIdFromTablet pour obtenir l'identificateur de contexte de la tablette et appelle la méthode GetTabletPropertyDescriptionCollection pour obtenir la liste des propriétés de paquet prises en charge par le Tablet PC.

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;

// ...

// Called when a tablet is added while the RealTimeStylus is enabled.
public void TabletAdded(RealTimeStylus sender, TabletAddedData data)
{
    // Display information about the tablet that was added.
    int theContextId =
        this.thePrimaryRealTimeStylus.GetTabletContextIdFromTablet(data.Tablet);

    this.theTextBox.Text = string.Format(
        "Tablet added, Name = {0}, ContextId={1}, available packet properties:"
        + Environment.NewLine, data.Tablet.Name, theContextId);

    TabletPropertyDescriptionCollection theTabletProperties =
        this.thePrimaryRealTimeStylus.GetTabletPropertyDescriptionCollection(theContextId);

    foreach(TabletPropertyDescription theTabletPropertyDescription in theTabletProperties)
    {
        // ...
    }
}

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.