StylusButtons.GetName Method

Článek
10/19/2012

Returns the name of the stylus button at the given index in the StylusButtons object.

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

Syntax

'Declaration
Public Function GetName ( _
    index As Integer _
) As String
'Usage
Dim instance As StylusButtons 
Dim index As Integer 
Dim returnValue As String 

returnValue = instance.GetName(index)

public string GetName(
    int index
)

public:
String^ GetName(
    int index
)

public function GetName(
    index : int
) : String

Parameters

index
Type: System.Int32

Return Value

Type: System.String
Returns the name for the stylus button.

Remarks

The name is defined by the manufacturer of the digitizer.

The list of buttons provided in this collection indicate what is supported by a digitizer and not necessarily what is present on the pen. You can determine the state of a specific stylus button, and confirm its presence, when the plug-in receives the StylusButtonDown and StylusButtonUp notifications.

Examples

This Microsoft Visual C# .NET example shows an event handler for the StylusButtonUp method implemented on a form:

public class Form1 : Form, IStylusAsyncPlugin
{
    private RealTimeStylus rts;
    private DynamicRenderer dr;
    private System.Windows.Forms.TextBox textBox1;
    public Form1()
    {
        rts = new RealTimeStylus(this);
        dr = new DynamicRenderer(this);
        rts.SyncPluginCollection.Add(dr);
        rts.AsyncPluginCollection.Add(this);
        rts.Enabled = true;
        dr.Enabled = true;

        InitializeComponent();
    }
    // ...
    public Microsoft.StylusInput.DataInterestMask DataInterest
    {
        get{return DataInterestMask.AllStylusData;}
    }
    public void StylusButtonUp(RealTimeStylus sender, StylusButtonUpData data)
    {
        textBox1.AppendText(
            string.Format("{0} button up: {1} ({2}){3}", 
            data.Stylus.Name, 
            data.Stylus.Buttons.GetName(data.ButtonIndex),
            data.ButtonIndex.ToString(),
            Environment.NewLine)
            );
    }
    // ...

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

Sdílet prostřednictvím