Ink.Clip Method

Article
12/12/2007

Removes the portions of a Stroke object or Strokes collection that are outside a given rectangle.

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

Syntax

'Declaration
Public Sub Clip ( _
    r As Rectangle _
)
'Usage
Dim instance As Ink
Dim r As Rectangle

instance.Clip(r)

public void Clip (
    Rectangle r
)

public:
void Clip (
    Rectangle r
)

public void Clip (
    Rectangle r
)

public function Clip (
    r : Rectangle
)

Not applicable.

Parameters

r
The rectangle outside of which the Stroke object or Strokes collection are clipped.

Remarks

The r paramter is specified in ink space coordinates.

Portions of the ink outside of the rectangle are deleted from the Ink object. Because of this, the Clip method may add new points to a Stroke object at the point where the Stroke object intersects the rectangle.

After you call the Clip method on an Ink object, the properties of each Stroke object in the Ink object's Strokes collection may change. For example, if a Stroke object begins within the area of the clip rectangle, exits the clip rectangle, and then returns to within the clip rectangle; it becomes two Stroke objects, at least one of which has a new Id property. Despite this behavior, all Id properties are guaranteed to be unique within an Ink object, even if they change. Other properties for the Stroke object may also undergo similar change.

This method does not take the pen width into account when clipping. It clips only the actual ink or stroke data.

For a Stroke object or Strokes collection, the Clip method updates the parent Ink object. Whenever ink is removed from an Ink object, any Stroke objects or Strokes collections defined for that Ink object may be invalidated.

For more information about how ink data is manipulated, see Ink Data.

Example

This C# example uses the Clip method to remove the portions of Stroke objects on an InkCollector control, theInkCollector, that are outside of a rectangle, theRectangle.

theInkCollector.Ink.Clip(theRectangle);

This Microsoft Visual Basic.NET example uses the Clip method to remove the portions of Stroke objects on an InkCollector control, theInkCollector, that are outside of a rectangle, theRectangle.

theInkCollector.Ink.Clip(theRectangle)

Platforms

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

Version Information

.NET Framework

Supported in: 3.0

Share via