StylusPointCollection Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Represents a collection of related StylusPoint objects.

Inheritance Hierarchy

System..::.Object
System.Windows..::.DependencyObject
System.Windows..::.PresentationFrameworkCollection<(Of <(StylusPoint>)>)
System.Windows.Input..::.StylusPointCollection

Namespace: System.Windows.Input
Assembly: System.Windows (in System.Windows.dll)
XMLNS for XAML: Not mapped to an xmlns.

Syntax

Public NotInheritable Class StylusPointCollection _
    Inherits PresentationFrameworkCollection(Of StylusPoint)
public sealed class StylusPointCollection : PresentationFrameworkCollection<StylusPoint>
<StylusPointCollection>
  oneOrMoreStylusPoints
</StylusPointCollection>

XAML Values

Value

Description

oneOrMoreStylusPoints

One or more StylusPoint object elements.

The StylusPointCollection type exposes the following members.

Constructors

Name Description
StylusPointCollection Initializes a new instance of the StylusPointCollection class.

Top

Properties

Name Description
Count Gets the number of elements contained in the PresentationFrameworkCollection<(Of <(T>)>). (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
Dispatcher Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
IsFixedSize Gets a value indicating whether the PresentationFrameworkCollection<(Of <(T>)>) has a fixed size. (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
IsReadOnly Gets a value indicating whether the PresentationFrameworkCollection<(Of <(T>)>) is read-only. (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
IsSynchronized Gets a value indicating whether access to the PresentationFrameworkCollection<(Of <(T>)>) is synchronized (thread safe). (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
Item Gets or sets the element at the specified index. (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
SyncRoot Gets an object that can be used to synchronize access to the PresentationFrameworkCollection<(Of <(T>)>). (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)

Top

Methods

Name Description
Add(T) Adds an item to the PresentationFrameworkCollection<(Of <(T>)>). (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
Add(StylusPointCollection) Adds a collection of StylusPoint objects to the collection.
CheckAccess Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Clear Removes all items from the PresentationFrameworkCollection<(Of <(T>)>). (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject.)
Contains Determines whether the PresentationFrameworkCollection<(Of <(T>)>) contains a specific value. (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
CopyTo(array<T>[]()[], Int32) Copies the elements of the PresentationFrameworkCollection<(Of <(T>)>) to an Array, starting at a particular Array index. (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
CopyTo(Array, Int32) Copies the elements of the PresentationFrameworkCollection<(Of <(T>)>) to an Array, starting at a particular Array index. (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
GetAnimationBaseValue Returns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
GetEnumerator Returns an enumerator that iterates through a collection. (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
GetType Gets the Type of the current instance. (Inherited from Object.)
GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
IndexOf Determines the index of a specific item in the PresentationFrameworkCollection<(Of <(T>)>). (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
Insert Inserts an item to the PresentationFrameworkCollection<(Of <(T>)>) at the specified index. (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Remove Removes the first occurrence of a specific object from the PresentationFrameworkCollection<(Of <(T>)>). (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
RemoveAt Removes the item at the specified index. (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

Name Description
IEnumerable..::.GetEnumerator Returns an enumerator that iterates through a collection. (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
IList..::.Add Adds an item to the PresentationFrameworkCollection<(Of <(T>)>). (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
IList..::.Contains Determines whether the PresentationFrameworkCollection<(Of <(T>)>) contains a specific value. (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
IList..::.IndexOf Determines the index of a specific item in the PresentationFrameworkCollection<(Of <(T>)>). (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
IList..::.Insert Inserts an item to the PresentationFrameworkCollection<(Of <(T>)>) at the specified index. (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
IList..::.Item Gets or sets the element at the specified index. (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)
IList..::.Remove Removes the first occurrence of a specific object from the PresentationFrameworkCollection<(Of <(T>)>). (Inherited from PresentationFrameworkCollection<(Of <(T>)>).)

Top

Remarks

The StylusPointCollection keeps track of the StylusPoint objects that define the geometry of the Stroke object.

A StylusPointCollection can belong to more than one Stroke object; however, the only way to do this is by assigning an existing StylusPoints value of one Stroke to another using code.

The XAML syntax for properties that use a StylusPoint is potentially an example of implicit collection syntax, in which you can omit an actual StylusPointCollection object element. However, prepopulating an InkPresenter with strokes and stylus points is not a common technique; usually you start with a blank Strokes collection and capture strokes into the collection as user input with run-time code.

Examples

The following code example iterates through stylus points of the strokes drawn in the first InkPresenter control to display its mirror image in the second InkPresenter control.

    Private MyStroke As Stroke

    Public Sub New()
        MyBase.New()
        InitializeComponent()
        SetBoundaryForIP1()
        SetBoundaryForIP2()
    End Sub

    'A new stroke object, MyStroke, is created and is added to the StrokeCollection object
    'of the InkPresenter, MyIP1
    Private Sub MyIP1_MouseLeftButtonDown(ByVal sender As Object, ByVal e As MouseEventArgs)
        MyIP1.CaptureMouse()
        Dim MyStylusPointCollection As StylusPointCollection = New StylusPointCollection
        MyStylusPointCollection.Add(e.StylusDevice.GetStylusPoints(MyIP1))
        MyStroke = New Stroke(MyStylusPointCollection)
        MyIP1.Strokes.Add(MyStroke)
    End Sub

    'StylusPoint objects are collected from the MouseEventArgs and added to MyStroke
    Private Sub MyIP1_MouseMove(ByVal sender As Object, ByVal e As MouseEventArgs)
        If (Not (MyStroke) Is Nothing) Then
            MyStroke.StylusPoints.Add(e.StylusDevice.GetStylusPoints(MyIP1))
        End If
    End Sub

    'MyStroke is completed
    Private Sub MyIP1_LostMouseCapture(ByVal sender As Object, ByVal e As MouseEventArgs)
        MyStroke = Nothing
    End Sub

    'Create the mirror image of the stroke collection in MyIP1 and adding it to MyIP2
    Private Sub BtMirror_Click(ByVal sender As Object, ByVal e As EventArgs)
        'Iterate through the Strokes in the StrokeCollection of MyIP1
        For Each stroke As Stroke In MyIP1.Strokes
            Dim newcollection As StylusPointCollection = New StylusPointCollection
            'Iterate through the stylus points of each stroke in MyIP1
            For Each p As StylusPoint In stroke.StylusPoints
                'Create the mirror image
                Dim newpoint As StylusPoint = New StylusPoint
                newpoint.X = (MyIP1.ActualWidth - p.X)
                newpoint.Y = p.Y
                newcollection.Add(newpoint)
            Next
            'Add the mirror image to MyIP2
            Dim newStroke As Stroke = New Stroke(newcollection)
            MyIP2.Strokes.Add(newStroke)
        Next
    End Sub
Stroke MyStroke;

//A new stroke object named MyStroke is created. MyStroke is added to the StrokeCollection of the InkPresenter named MyIP1
private void MyIP1_MouseLeftButtonDown(object sender, MouseEventArgs e)
{
    MyIP1.CaptureMouse();
    StylusPointCollection MyStylusPointCollection = new StylusPointCollection();
    MyStylusPointCollection.Add(e.StylusDevice.GetStylusPoints(MyIP1));
    MyStroke = new Stroke(MyStylusPointCollection);
    MyIP1.Strokes.Add(MyStroke);
}

//StylusPoint objects are collected from the MouseEventArgs and added to MyStroke
private void MyIP1_MouseMove(object sender, MouseEventArgs e)
{
    if (MyStroke != null)
        MyStroke.StylusPoints.Add(e.StylusDevice.GetStylusPoints(MyIP1));
}

//MyStroke is completed
private void MyIP1_LostMouseCapture(object sender, MouseEventArgs e)
{
    MyStroke = null;
}

//Create the mirror image of the stroke collection in MyIP1 and adding it to MyIP2
private void BtMirror_Click(object sender, EventArgs e)
{
    //Iterate through the Strokes in the StrokeCollection of MyIP1
    foreach (Stroke stroke in MyIP1.Strokes)
    {
        StylusPointCollection newcollection = new StylusPointCollection();
        //Iterate through the stylus points of each stroke in MyIP1
        foreach (StylusPoint p in stroke.StylusPoints)
        {
            //Create the mirror image
            StylusPoint newpoint = new StylusPoint();
            newpoint.X = MyIP1.ActualWidth - p.X;
            newpoint.Y = p.Y;
            newcollection.Add(newpoint);
        }
        //Add the mirror image to MyIP2
        Stroke newStroke = new Stroke(newcollection);
        MyIP2.Strokes.Add(newStroke);
    }
}

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

System.Windows.Input Namespace

StylusPoint

Stroke