Ink.GetBoundingBox Method (BoundingBoxMode)
Returns the bounding Rectangle that contains all of the Stroke objects in the Ink 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 Ink
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.BoundingBoxModeA member of the BoundingBoxMode enumeration, which specifies which characteristics of a stroke, such as drawing attributes, are used to calculate the bounding box of the ink.
Return Value
Type: System.Drawing.Rectangle
The Rectangle that defines the bounding box of the Strokes collection in the Ink object.
Remarks
The bounding Rectangle is in ink space coordinates.
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, it is 53 by default. 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. Consider an example in which 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 that this method returns is a copy of the bounding box of the Strokes collection of the Ink object. Altering the Rectangle that this method returns has no affect on the bounding box of the original Ink object.
Note
In Windows Vista and later versions, GetBoundingBox Method does not take the width of the stroke into account.
Examples
This C# example returns the bounding Rectangle that contains the Strokes collection in an Ink object. The Ink object is associated with an InkCollector object, theInkCollector. The example uses the CurveFit value of the BoundingBoxMode enumeration to determine the bounds of the bounding box.
Rectangle theBoundingBox =
theInkCollector.Ink.GetBoundingBox(BoundingBoxMode.CurveFit);
This Microsoft Visual Basic.NET example returns the bounding Rectangle that contains the Strokes collection in an Ink object. The Ink object is associated with an InkCollector object, theInkCollector. The example uses the BoundingBoxMode value of the BoundingBoxMode enumeration to determine the bounds.
Dim theBoundingBox As Rectangle = _
theInkCollector.Ink.GetBoundingBox(BoundingBoxMode.CurveFit)
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