InkAnalyzer.RemoveStroke Method

Article
10/19/2012

Removes a Stroke from the ink analyzer.

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

Syntax

'Declaration
Public Sub RemoveStroke ( _
    strokeToRemove As Stroke _
)
'Usage
Dim instance As InkAnalyzer 
Dim strokeToRemove As Stroke

instance.RemoveStroke(strokeToRemove)

public void RemoveStroke(
    Stroke strokeToRemove
)

public:
void RemoveStroke(
    Stroke^ strokeToRemove
)

public function RemoveStroke(
    strokeToRemove : Stroke
)

Parameters

strokeToRemove
Type: Microsoft.Ink.Stroke

The stroke to remove.

Remarks

This method removes strokeToRemove from the InkAnalyzer.

This method removes strokeToRemove from the leaf context node that references the stroke. If the context node no longer references any strokes, this method deletes the context node and any ancestor nodes that no longer have any child nodes.

After this method removes the stroke from the context node, it updates the DirtyRegion to include the bounding box of the removed stroke.

If the stroke is not associated with the ink analyzer, this method returns without updating the ink analyzer.

This method throws a System.ArgumentNullException when strokeToRemove is nulla null reference (Nothing in Visual Basic).

Examples

This example determines if a Stroke, theStroke, has a bounding box with a left bound lower than the 32-bit signed integer, leftBound. If so, it removes theStroke from the InkAnalyzer, theInkAnalyzer.

' Remove the stroke if its bounding box falls outside of the left bound. 
If theStroke IsNot Nothing _
    AndAlso theStroke.GetBoundingBox().Left < leftBound Then 

    Me.theInkAnalyzer.RemoveStroke(theStroke)
End If

// Remove the stroke if its bounding box falls outside of the left bound. 
if (theStroke != null && theStroke.GetBoundingBox().Left < leftBound)
{
    this.theInkAnalyzer.RemoveStroke(theStroke);
}

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