Share via


StylusButtons.Count Property

Gets the number of buttons on the stylus.

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

Syntax

'Declaration
Public ReadOnly Property Count As Integer
'Usage
Dim instance As StylusButtons 
Dim value As Integer 

value = instance.Count
public int Count { get; }
public:
property int Count {
    int get ();
}
public function get Count () : int

Property Value

Type: System.Int32
The number of buttons on the stylus.

Remarks

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 StylusInRange 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 StylusInRange(RealTimeStylus sender, StylusInRangeData data)
    {
        string sInverted = data.Stylus.Inverted ? "is inverted" : "is not inverted";
        
        textBox1.AppendText(
            string.Format("{0} in range; {1}; has {2} buttons:{3}", 
                data.Stylus.Name, 
                sInverted,
                data.Stylus.Buttons.Count,
                Environment.NewLine)
            );

        for (int i=0; i<data.Stylus.Buttons.Count; i++)
        {
            textBox1.AppendText(
                string.Format("    {0}: {1}{2}", 
                    i.ToString(),
                    data.Stylus.Buttons.GetName(i),
                    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

See Also

Reference

StylusButtons Class

StylusButtons Members

Microsoft.StylusInput Namespace

Microsoft.StylusInput.PluginData.StylusButtonDataBase

Microsoft.StylusInput.PluginData.StylusButtonDownData

Microsoft.StylusInput.PluginData.StylusButtonUpData