InkAnalyzerBase.SetStrokeType Method

Article
12/12/2007

Changes the type of the specified stroke.

Namespace: System.Windows.Ink.AnalysisCore
Assembly: IACore (in iacore.dll)

Syntax

'Declaration
Public Sub SetStrokeType ( _
    strokeId As Integer, _
    strokeType As StrokeType _
)
'Usage
Dim instance As InkAnalyzerBase
Dim strokeId As Integer
Dim strokeType As StrokeType

instance.SetStrokeType(strokeId, strokeType)

public void SetStrokeType (
    int strokeId,
    StrokeType strokeType
)

public:
void SetStrokeType (
    int strokeId, 
    StrokeType strokeType
)

public void SetStrokeType (
    int strokeId, 
    StrokeType strokeType
)

public function SetStrokeType (
    strokeId : int, 
    strokeType : StrokeType
)

Not applicable.

Parameters

strokeId
The stroke identifier of the stroke to which to assign strokeType.

strokeType
The stroke type to assign to the stroke.

Remarks

If a stroke's type is the StrokeType value Unspecified, the ink analyzer classifies the stroke during ink analysis. Otherwise, the analyzer uses the type set on the stroke.

The ink analyzer does not set the stroke type value as part of ink analysis. To get the type currently assigned to a stroke, call GetStrokeType.

If a stroke is associated with a context node that is not an unclassified ink node, this method moves the stroke to an unclassified ink node that contains strokes of the same language. If no such context node exists, this method creates a new unclassified ink node and adds the stroke to it. An unclassified ink node is a ContextNodeBase that has a Type property value of UnclassifiedInk.

If this method moves a stroke, this method also adds the stroke's bounding box to the ink analyzer's DirtyRegion.

This method does not move a stroke if the strokeType parameter matches the stroke's current type.

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

Example

The following example checks the type of a specified stroke and sets it to Unspecified if it is not already set to Unspecified. The InkAnalyzerBase, theInkAnalyzerBase, contains stroke data for the stroke identifier, theStrokeId.

' If the specified stroke is not set to unspecified,
' Set the stroke's type to unspecified.
Dim theStrokeType As System.Windows.Ink.AnalysisCore.StrokeType = _
    theInkAnalyzerBase.GetStrokeType(theStrokeId)
If System.Windows.Ink.AnalysisCore.StrokeType.Unspecified <> theStrokeType Then
    theInkAnalyzerBase.SetStrokeType( _
        theStrokeId, System.Windows.Ink.AnalysisCore.StrokeType.Unspecified)
End If

// If the specified stroke is not set to unspecified,
// Set the stroke's type to unspecified.
System.Windows.Ink.AnalysisCore.StrokeType theStrokeType =
    theInkAnalyzerBase.GetStrokeType(theStrokeId);
if (System.Windows.Ink.AnalysisCore.StrokeType.Unspecified != theStrokeType)
{
    theInkAnalyzerBase.SetStrokeType(theStrokeId,
        System.Windows.Ink.AnalysisCore.StrokeType.Unspecified);
}

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