This documentation is archived and is not being maintained.

InkAnalyzerBase.Analyze Method

Performs synchronous ink analysis.

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

public AnalysisStatusBase Analyze ()
public AnalysisStatusBase Analyze ()
public function Analyze () : AnalysisStatusBase
Not applicable.

Return Value

The status of the analysis operation.

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.

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.
System.Windows.Ink.AnalysisCore.AnalysisStatusBase theStatus = null;
if (!theInkAnalyzerBase.DirtyRegion.IsEmpty)
{
    // Perform the ink analysis.
    theStatus = theInkAnalyzerBase.Analyze();
}

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.

.NET Framework

Supported in: 3.0
Show: