Stylus.Buttons Property

Gets the stylus buttons that are available on the stylus. The buttons may include the pen tip, the eraser end, and the barrel.

Definition

Visual Basic .NET	Public ReadOnly Property Buttons As StylusButtons
C#	public StylusButtons Buttons { get; }
Managed C++	public: __property StylusButtons* get_Buttons();

Property Value

Microsoft.StylusInput.StylusButtons. The stylus buttons that are available on the stylus.

This property is read-only. This property has no default value.

Examples

This Microsoft® Visual C#® .NET example is a snippet from a form's helper method, StylusDataToString. The helper method takes a Stylus object and returns a string containing information about the stylus and its buttons.

[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;

// ...

// Returns information about a given stylus.
private string StylusDataToString(Stylus theStylus)
{
    System.Text.StringBuilder result = new System.Text.StringBuilder();

    // Add information about the tablet pen.
    result.Append(
        string.Format("  Name = {0}, Id = {1}, ContextId = {2}, Inverted = {3}, Button Count = {4}."
        + Environment.NewLine, theStylus.Name, theStylus.Id,
        theStylus.TabletContextId, theStylus.Inverted, theStylus.Buttons.Count));

    // Add information about each of the tabet pen's buttons.
    for (int i=0; i<theStylus.Buttons.Count; i++)
    {
        result.Append(
            string.Format("    Button {0}: Name = {1}, Id = {2}" + Environment.NewLine,
            i, theStylus.Buttons.GetName(i), theStylus.Buttons.GetId(i)));
    }

    return result.ToString();
}