Stroke.GetBounds Method

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

Retrieves the bounding box for the Stroke object.

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

Syntax

'Declaration
Public Function GetBounds As Rect

public Rect GetBounds()

Return Value

Type: System.Windows.Rect
A Rect structure defining the bounding box for the Stroke object.

Remarks

Do not attempt to set values in the returned Rect. It should be used for reference only.

There are various scenarios for using the returned Rect. The Rect can be used as input for a RectangleGeometry that displays a bounding box in the user interface, or it can be used to check for intersecting strokes or other types of hit-testing.

Examples

The following code example demonstrates the GetBounds method of the Stroke object.

Run this sample

    Private MyStroke As Stroke

    Public Sub New()
        MyBase.New()
        InitializeComponent()
        SetBoundary()
    End Sub

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

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

    'GetBounds() method is used to draw a rectangular boundary on every stroke 
    'as soon as the stroke is completed.
    Private Sub MyIP_LostMouseCapture(ByVal sender As Object, ByVal e As MouseEventArgs)
        Dim MyRect As Rect = New Rect
        MyRect = MyStroke.GetBounds
        Dim MyRectangle As Rectangle = New Rectangle
        MyRectangle.Height = MyRect.Height
        MyRectangle.Width = MyRect.Width
        Dim MyThickness As Thickness = New Thickness(MyRect.X, MyRect.Top, 0, 0)
        MyRectangle.Margin = MyThickness
        Dim MyBrush As SolidColorBrush = New SolidColorBrush(Colors.Black)
        MyRectangle.Stroke = MyBrush
        MyIP.Children.Add(MyRectangle)
        MyStroke = Nothing
    End Sub

Stroke MyStroke;

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

    MyIP.Strokes.Add(MyStroke);
}

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

//GetBounds() method is used to draw a rectangular boundary on every stroke 
//as soon as the stroke is completed.
private void MyIP_LostMouseCapture(object sender, MouseEventArgs e)
{
    Rect MyRect = new Rect();
    MyRect = MyStroke.GetBounds();
    Rectangle MyRectangle = new Rectangle();
    MyRectangle.Height = MyRect.Height;
    MyRectangle.Width = MyRect.Width;
    Thickness MyThickness = new Thickness(MyRect.X, MyRect.Top, 0, 0);
    MyRectangle.Margin = MyThickness;
    SolidColorBrush MyBrush = new SolidColorBrush(Colors.Black);
    MyRectangle.Stroke = MyBrush;
    MyIP.Children.Add(MyRectangle);
    MyStroke = null;
}

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.

See Also

Reference

Stroke Class

System.Windows.Ink Namespace

Other Resources

Ink Overview