InkAnalyzerBase.SetStrokesType Method

Article
12/12/2007

Changes the type of the specified strokes.

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

Syntax

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

instance.SetStrokesType(strokeIds, strokeType)

public void SetStrokesType (
    int[] strokeIds,
    StrokeType strokeType
)

public:
void SetStrokesType (
    array<int>^ strokeIds, 
    StrokeType strokeType
)

public void SetStrokesType (
    int[] strokeIds, 
    StrokeType strokeType
)

public function SetStrokesType (
    strokeIds : int[], 
    strokeType : StrokeType
)

Not applicable.

Parameters

strokeIds
An array containing the stroke identifiers of the strokes to which to assign strokeType.

strokeType
The stroke type to assign to the strokes.

Remarks

If a stroke's type is the StrokeType value of 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 a stroke identified in strokeIds is not associated with the ink analyzer, this method ignores the identifier.

If none of the strokes identified in strokeIds identify a stroke associated with the ink analyzer, this method returns without updating the ink analyzer.

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

Example

The following example sets the stroke type to the StrokeType value Writing and the stroke locale to French for all the strokes in the specified node. The InkAnalyzerBase, theInkAnalyzerBase, contains the specified ContextNodeBase, theNode.

' For all strokes in the specified node or one of its descendants,
' set the stroke type to Writing and the stroke locale to French.
Dim theStrokeIds As Integer() = theNode.GetStrokeIds()
If 0 < theStrokeIds.Length Then
    theInkAnalyzerBase.SetStrokesType( _
        theStrokeIds, System.Windows.Ink.AnalysisCore.StrokeType.Writing)
    theInkAnalyzerBase.SetStrokesLanguageId(theStrokeIds, &H40C)
End If

// For all strokes in the specified node or one of its descendants,
// set the stroke type to Writing and the stroke locale to French.
int[] theStrokeIds = theNode.GetStrokeIds();
if (0 < theStrokeIds.Length)
{
    theInkAnalyzerBase.SetStrokesType(theStrokeIds,
        System.Windows.Ink.AnalysisCore.StrokeType.Writing);
    theInkAnalyzerBase.SetStrokesLanguageId(theStrokeIds, 0x040c);
}

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