Compartir a través de

RealTimeStylus.GetTabletContextIDFromTablet Method

  • Artículo

RealTimeStylus.GetTabletContextIDFromTablet Method

Gets the tablet context identifer object that is associated with a given Tablet object.

Definition

Visual Basic .NET Public Function GetTabletContextIDFromTablet( _
ByVal tablet As Tablet _
) As Integer
C# public int GetTabletContextIDFromTablet(
Tablet tablet
);
Managed C++ public: int* GetTabletContextIDFromTablet(
Tablet *tablet
);

Parameters

tablet Microsoft.Ink.Tablet. The tablet context identifier that is associated with a given Tablet object.

Return Value

System.Int32. The tablet context identifer object that is associated with a given Tablet object.

Exceptions

ArgumentNullException Leave Site:
COMException Leave Site:
ObjectDisposedException Leave Site: The object is already disposed.

Remarks

Note: A tablet context identifier is specific to RealTimeStylus object. Two RealTimeStylus objects may have a different context identifiers for the same tablet.

Examples

This Microsoft® Visual C#® .NET example is a snippet from the implementation of the IStylusAsyncPlugin interface's TabletAdded method. The form which implements the IStylusAsyncPlugin interface contains a TextBox Leave Site object, theTextBox. The TabletAdded method displays information about the tablet that was added, calls the GetTabletContextIDFromTablet method to get the tablet's context identifier, and calls the GetTabletPropertyDescriptionCollection method to get the list of packet properties supported by the tablet.

[C#]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)
    {
        // ...
    }
}

See Also