• Article

StrokeCollection Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Represents a collection of Stroke objects.

Inheritance Hierarchy

System.Object
  System.Windows.DependencyObject
    System.Windows.PresentationFrameworkCollection<Stroke>
      System.Windows.Ink.StrokeCollection

Namespace:  System.Windows.Ink
Assembly:  System.Windows (in System.Windows.dll)

Syntax

'Declaration
Public NotInheritable Class StrokeCollection _
    Inherits PresentationFrameworkCollection(Of Stroke)

public sealed class StrokeCollection : PresentationFrameworkCollection<Stroke>

<StrokeCollection .../>

The StrokeCollection type exposes the following members.

Constructors

  Name Description
Public methodSupported by Silverlight for Windows Phone StrokeCollection Initializes a new instance of the StrokeCollection class.

Top

Properties

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

Top

Methods

  Name Description
Public methodSupported by Silverlight for Windows Phone Add Adds an item to the PresentationFrameworkCollection<T>. (Inherited from PresentationFrameworkCollection<T>.)
Public methodSupported by Silverlight for Windows Phone CheckAccess Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone Clear Removes all items from the PresentationFrameworkCollection<T>. (Inherited from PresentationFrameworkCollection<T>.)
Public methodSupported by Silverlight for Windows Phone ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone Contains Determines whether the PresentationFrameworkCollection<T> contains a specific value. (Inherited from PresentationFrameworkCollection<T>.)
Public methodSupported by Silverlight for Windows Phone CopyTo(array<T[], Int32) Copies the elements of the PresentationFrameworkCollection<T> to an Array, starting at a particular Array index. (Inherited from PresentationFrameworkCollection<T>.)
Public methodSupported by Silverlight for Windows Phone CopyTo(Array, Int32) Copies the elements of the PresentationFrameworkCollection<T> to an Array, starting at a particular Array index. (Inherited from PresentationFrameworkCollection<T>.)
Public methodSupported by Silverlight for Windows Phone Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows Phone 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.)
Public methodSupported by Silverlight for Windows Phone GetAnimationBaseValue Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone GetBounds Returns the bounds of the strokes in the collection.
Public methodSupported by Silverlight for Windows Phone GetEnumerator Returns an enumerator that iterates through a collection. (Inherited from PresentationFrameworkCollection<T>.)
Public methodSupported by Silverlight for Windows Phone GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetType Gets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone HitTest Indicates whether a specified StylusPointCollection intersects with a StrokeCollection object.
Public methodSupported by Silverlight for Windows Phone IndexOf Determines the index of a specific item in the PresentationFrameworkCollection<T>. (Inherited from PresentationFrameworkCollection<T>.)
Public methodSupported by Silverlight for Windows Phone Insert Inserts an item to the PresentationFrameworkCollection<T> at the specified index. (Inherited from PresentationFrameworkCollection<T>.)
Protected methodSupported by Silverlight for Windows Phone MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone Remove Removes the first occurrence of a specific object from the PresentationFrameworkCollection<T>. (Inherited from PresentationFrameworkCollection<T>.)
Public methodSupported by Silverlight for Windows Phone RemoveAt Removes the item at the specified index. (Inherited from PresentationFrameworkCollection<T>.)
Public methodSupported by Silverlight for Windows Phone SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

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

Top

Remarks

The Strokes property of the InkPresenter class uses the StrokeCollection object to store Stroke information.

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.

Run this sample

    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

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

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.Ink Namespace

Stroke

Other Resources

Ink Overview