Strokes.GetBoundingBox Method (BoundingBoxMode)

Article
10/19/2012

Returns the bounding Rectangle that contains the Stroke object, by using the specified BoundingBoxMode flag to determine the bounds.

Namespace: Microsoft.Ink
Assembly: Microsoft.Ink (in Microsoft.Ink.dll)

Syntax

'Declaration
Public Function GetBoundingBox ( _
    mode As BoundingBoxMode _
) As Rectangle
'Usage
Dim instance As Strokes 
Dim mode As BoundingBoxMode 
Dim returnValue As Rectangle 

returnValue = instance.GetBoundingBox(mode)

public Rectangle GetBoundingBox(
    BoundingBoxMode mode
)

public:
Rectangle GetBoundingBox(
    BoundingBoxMode mode
)

public function GetBoundingBox(
    mode : BoundingBoxMode
) : Rectangle

Parameters

mode
Type: Microsoft.Ink.BoundingBoxMode

A member of the BoundingBoxMode enumeration that specifies which characteristics of a Strokes collection, such as drawing attributes, are used to calculate the bounding box of the Strokes collection.

Return Value

Type: System.Drawing.Rectangle
Returns the bounding Rectangle that defines the bounding box for the Strokes collection.

Remarks

The bounding Rectangle is in ink space coordinates.

The bounding Rectangle corresponds to the portion of the display to invalidate or redraw when displaying a Strokes collection.

The bounding box is cached for all modes other than the BoundingBoxMode mode.

When the bounding box is affected by the pen width, then this width is scaled appropriately for the Renderer object's view transform. To do this, the pen width is multiplied by the square root of the determinant of the view transform.

Note

If you have not set the pen width explicitly, the default value is 53. You must multiply the pen width by the square root of the determinant to yield the correct bounding box. The height and width of the bounding box are expanded by half this amount in each direction. For example, consider that the pen width is 53, the square root of the determinant is 50, and the bounding box is (0, 0, 1000, 1000). The pen width adjustment to the bounding box in each direction is calculated as (53 * 50) / 2, and the right and bottom sides are incremented by one. This results in a rendered bounding box of (-1325, -1325, 2326, 2326).

Note

The bounding Rectangle returned by this method is a copy of the bounding box of the Strokes collection. Altering the Rectangle that this method returns has no affect on the bounding box of the original Strokes collection.

Examples

In this example, a Strokes collection of an InkOverlay,object is scaled to fit into the left half of the original bounding box. First, the bounding rectangle of the Strokes collection is obtained by calling the GetBoundingBox method using the CurveFit value of the BoundingBoxMode enumeration to determine the bounds of the bounding box. A new rectangle with half the width of the original is then created and passed to the ScaleToRectangle method.

' Access to the Strokes property returns a copy of the Strokes object. 
' This copy must be implicitly (via using statement) or explicitly 
' disposed of in order to avoid a memory leak. 
Using allStrokes As Strokes = mInkOverlay.Ink.Strokes
    Dim bounds As Rectangle = allStrokes.GetBoundingBox(BoundingBoxMode.CurveFit)
    Dim halfRectangle As Rectangle = _
            New Rectangle(bounds.Left, bounds.Top, bounds.Width / 2, bounds.Height)
    allStrokes.ScaleToRectangle(halfRectangle)
End Using

// Access to the Strokes property returns a copy of the Strokes object. 
// This copy must be implicitly (via using statement) or explicitly 
// disposed of in order to avoid a memory leak. 
using (Strokes allStrokes = mInkOverlay.Ink.Strokes)
{
    Rectangle bounds = allStrokes.GetBoundingBox(BoundingBoxMode.CurveFit);
    Rectangle halfRectangle = 
        new Rectangle(bounds.Left, bounds.Top, bounds.Width / 2, bounds.Height);
    allStrokes.ScaleToRectangle(halfRectangle);
}

Platforms

Windows 7, Windows Vista, Windows Server 2008 R2, Windows Server 2008

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.0

Share via