InkAnalyzerBase.DirtyRegion Property

Article
12/12/2007

Gets the area that has changed since the last analysis operation. You can also use this property to manually modify this region.

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

Syntax

'Declaration
Public ReadOnly Property DirtyRegion As AnalysisRegionBase
'Usage
Dim instance As InkAnalyzerBase
Dim value As AnalysisRegionBase

value = instance.DirtyRegion

public AnalysisRegionBase DirtyRegion { get; }

public:
property AnalysisRegionBase^ DirtyRegion {
    AnalysisRegionBase^ get ();
}

/** @property */
public AnalysisRegionBase get_DirtyRegion ()

public function get DirtyRegion () : AnalysisRegionBase

Not applicable.

Property Value

The area that has changed since the last analysis operation.

Remarks

This property identifies the areas that need to be analyzed or reanalyzed. All of the InkAnalyzerBase methods that add, remove, or update stroke data also update the DirtyRegion property. To manually mark an area for reanalysis, use the DirtyRegion object's Union method.

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 property may contain nonadjacent areas.

Example

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 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