DivisionResult.ResultByType Method
Gets the requested structural units of the analysis results for a DivisionUnits collection.
Namespace: Microsoft.Ink
Assembly: Microsoft.Ink (in Microsoft.Ink.dll)
Syntax
'Declaration
Public Function ResultByType ( _
divisionType As InkDivisionType _
) As DivisionUnits
'Usage
Dim instance As DivisionResult
Dim divisionType As InkDivisionType
Dim returnValue As DivisionUnits
returnValue = instance.ResultByType(divisionType)
public DivisionUnits ResultByType(
InkDivisionType divisionType
)
public:
DivisionUnits^ ResultByType(
InkDivisionType divisionType
)
public function ResultByType(
divisionType : InkDivisionType
) : DivisionUnits
Parameters
divisionType
Type: Microsoft.Ink.InkDivisionTypeOne of the values of the InkDivisionType enumeration, which indicates the structural units to return.
Return Value
Type: Microsoft.Ink.DivisionUnits
Returns the DivisionUnits collection containing the requested structural units of the analysis results.
Remarks
This method returns a new DivisionUnits collection each time the method is called.
If no structural units of the requested type exist in the DivisionResult object, then this method returns an empty DivisionUnits collection.
Examples
This C# example creates a Divider object, theDivider, which contains a Strokes collection, theStrokes, and uses a RecognizerContext object, theRecognizerContext. The Divide method is called to get a snapshot of the analysis results, theResult. The ResultByType method is called with the divisionType parameter set to InkDivisionType to retrieve all of the line units within theResult. For each line, theLine, in the Strokes collection, the DivisionUnit.DivisionType, DivisionUnit.Strokes, DivisionUnit.RecognitionString, and DivisionUnit.Transform properties are retrieved.
// Create the Divider and assign a Strokes collection to it.
Divider theDivider = new Divider(theStrokes, theRecognizerContext);
// Retrieve the analysis result, and divide the result by line.
DivisionResult theResult = theDivider.Divide();
DivisionUnits theDivisionUnits =
theResult.ResultByType(InkDivisionType.Line);
foreach (DivisionUnit theLine in theDivisionUnits)
{
// For each line element in the collection
// retrieve the division type, the strokes,
// the recognition string, and the rotation transform.
InkDivisionType theDivisionType = theLine.DivisionType;
Strokes elementStrokes = theLine.Strokes;
string theRecognitionString = theLine.RecognitionString;
System.Drawing.Drawing2D.Matrix theInkTransform =
theLine.Transform;
}
This Microsoft® Visual Basic® .NET example creates a Divider object, theDivider, which contains a Strokes collection, theStrokes, and uses a RecognizerContext object, theRecognizerContext. The Divide method is called to get a snapshot of the analysis results, theResult. The ResultByType method is called with the divisionType parameter set to InkDivisionType to retrieve all of the line units within theResult. For each line, theLine, in the Strokes collection, the DivisionUnit.DivisionType, DivisionUnit.Strokes, DivisionUnit.RecognitionString, and DivisionUnit.Transform properties are retrieved.
' Create the Divider and assign a Strokes collection to it.
Dim theDivider As Divider = New Divider(theStrokes, theRecognizerContext)
' Retrieve the analysis result, and divide the result by line.
Dim theResult As DivisionResult = theDivider.Divide()
Dim theDivisionUnits As DivisionUnits = _
theResult.ResultByType(InkDivisionType.Line)
Dim theLine As DivisionUnit
For Each theLine In theDivisionUnits
' For each line element in the collection
' retrieve the division type, the strokes,
' the recognition string, and the rotation transform.
Dim theDivisionType As InkDivisionType = theLine.DivisionType
Dim elementStrokes As Strokes = theLine.Strokes
Dim theRecognitionString As String = theLine.RecognitionString
Dim theInkTransform As System.Drawing.Drawing2D.Matrix = _
theLine.Transform
Next
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