StylusShape Class

Definition

Namespace:

System.Windows.Ink

Assembly:

PresentationCore.dll

Represents the tip of a stylus.

public ref class StylusShape abstract

public abstract class StylusShape

type StylusShape = class

Public MustInherit Class StylusShape

Inheritance

Object

StylusShape

Derived

System.Windows.Ink.EllipseStylusShape

System.Windows.Ink.RectangleStylusShape

Examples

The following example demonstrates how to create a StylusShape and pass it to the GetIncrementalStrokeHitTester method to erase a portion of a Stroke. This example assumes that there is a IncrementalStrokeHitTester called eraseTester and that its StrokeHit event has been connected to the event handler defined in this example. To create a control that allows a user to erase ink, see How to: Erase Ink on a Custom Control.

// Prepare to collect stylus packets. Get the 
// IncrementalHitTester from the InkPresenter's 
// StrokeCollection and subscribe to its StrokeHitChanged event.
protected override void OnStylusDown(StylusDownEventArgs e)
{
    base.OnStylusDown(e);

    EllipseStylusShape eraserTip = new EllipseStylusShape(3, 3, 0);
    eraseTester = 
        presenter.Strokes.GetIncrementalStrokeHitTester(eraserTip);
    eraseTester.StrokeHit += new StrokeHitEventHandler(eraseTester_StrokeHit);
    eraseTester.AddPoints(e.GetStylusPoints(this));
}

' Prepare to collect stylus packets. Get the 
' IncrementalHitTester from the InkPresenter's 
' StrokeCollection and subscribe to its StrokeHitChanged event.
Protected Overrides Sub OnStylusDown(ByVal e As StylusDownEventArgs)

    MyBase.OnStylusDown(e)

    Dim eraserTip As New EllipseStylusShape(3, 3, 0)
    eraseTester = presenter.Strokes.GetIncrementalStrokeHitTester(eraserTip)
    AddHandler eraseTester.StrokeHit, _
        AddressOf eraseTester_StrokeHit
    eraseTester.AddPoints(e.GetStylusPoints(Me))

End Sub

Remarks

The StylusShape specifies the shape, width, and height of the tip of a stylus. Methods such as Erase and HitTest use a StylusShape to determine the stylus tip of the hitting stroke. The EllipseStylusShape and RectangleStylusShape classes inherit from StylusShape.

XAML Text Usage

This class is not typically used in XAML.

Properties

Height	Gets the height of the stylus.
Rotation	Gets the angle of the stylus.
Width	Gets the width of the stylus.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)