RealTimeStylus.GetTabletPropertyDescriptionCollection Method

Article
12/08/2012

Returns the TabletPropertyDescriptionCollection collection that is associated with a given tablet context identifier.

Namespace: Microsoft.StylusInput
Assembly: Microsoft.Ink (in Microsoft.Ink.dll)

Syntax

'Declaration
Public Function GetTabletPropertyDescriptionCollection ( _
    tabletContextId As Integer _
) As TabletPropertyDescriptionCollection
'Usage
Dim instance As RealTimeStylus 
Dim tabletContextId As Integer 
Dim returnValue As TabletPropertyDescriptionCollection 

returnValue = instance.GetTabletPropertyDescriptionCollection(tabletContextId)

public TabletPropertyDescriptionCollection GetTabletPropertyDescriptionCollection(
    int tabletContextId
)

public:
TabletPropertyDescriptionCollection^ GetTabletPropertyDescriptionCollection(
    int tabletContextId
)

public function GetTabletPropertyDescriptionCollection(
    tabletContextId : int
) : TabletPropertyDescriptionCollection

Parameters

tabletContextId
Type: System.Int32

The tablet context identifier for the Tablet object for which you want the packet property descriptions.

Return Value

Type: Microsoft.Ink.TabletPropertyDescriptionCollection
The TabletPropertyDescriptionCollection collection associated with a given tablet context identifier.

Remarks

This method throws an exception when the RealTimeStylus is disabled or disposed.

Examples

This C# example is a snippet from the implementation of the IStylusAsyncPlugin interface's TabletAdded method. The form which implements the IStylusAsyncPlugin interface contains a TextBox 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.

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)
    {
        // ...
    }
}

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.0

Share via