Share via


InkAnalyzerBase.Analyze Method

Performs synchronous ink analysis.

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

Syntax

'Declaration
Public Function Analyze As AnalysisStatusBase
'Usage
Dim instance As InkAnalyzerBase 
Dim returnValue As AnalysisStatusBase 

returnValue = instance.Analyze()
public AnalysisStatusBase Analyze()
public:
AnalysisStatusBase^ Analyze()
public function Analyze() : AnalysisStatusBase

Return Value

Type: System.Windows.Ink.AnalysisCore.AnalysisStatusBase
The status of the analysis operation.

Remarks

This method starts a synchronous ink analysis operation. Ink analysis includes layout analysis, writing and drawing classification, and handwriting recognition. This method returns after the analysis operation is complete.

The InkAnalyzerBase analyzes ink within its DirtyRegion during a call to Analyze or BackgroundAnalyze. However, the ink analyzer may expand the analysis operation to include neighboring regions.

This method sets the InkAnalyzerBase object's DirtyRegion to an empty region. If another thread has added stroke data that has not been analyzed, the InkAnalyzerBase adds the bounding box of the unanalyzed strokes to its DirtyRegion during the reconcile phase of the analysis.

This method throws an exception when your application has not added an event handler for the UpdateStrokesCacheBase event.

The InkAnalyzerBase does not raise the ResultsUpdatedBase and IntermediateResultsUpdatedBase events in response to this method.

To modify the way ink analysis is performed, use the AnalysisModes property.

For more information about ink analysis, see Ink Analysis Overview.

Examples

This example performs ink analysis on an InkAnalyzerBase, theInkAnalyzerBase, if the analyzer's DirtyRegion is not empty.

' Only start ink analysis if the dirty region is not empty. 
Dim theStatus As System.Windows.Ink.AnalysisCore.AnalysisStatusBase = Nothing 
If Not theInkAnalyzerBase.DirtyRegion.IsEmpty Then 

    ' Perform the ink analysis.
    theStatus = theInkAnalyzerBase.Analyze()

End If
// Only start ink analysis if the dirty region is not empty.
System.Windows.Ink.AnalysisCore.AnalysisStatusBase theStatus = null;
if (!theInkAnalyzerBase.DirtyRegion.IsEmpty)
{
    // Perform the ink analysis.
    theStatus = theInkAnalyzerBase.Analyze();
}

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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

See Also

Reference

InkAnalyzerBase Class

InkAnalyzerBase Members

System.Windows.Ink.AnalysisCore Namespace

InkAnalyzerBase.AnalysisModes

InkAnalyzerBase.DirtyRegion

InkAnalyzerBase.RootNode

InkAnalyzerBase.BackgroundAnalyze