InkAnalyzer.DirtyRegion Property

Article
12/12/2007

Gets the area that has changed since the last analysis operation.

Namespace: System.Windows.Ink
Assembly: IAWinFX (in iawinfx.dll)
XML Namespace: https://schemas.microsoft.com/winfx/2006/xaml/presentation

Syntax

'Declaration
Public ReadOnly Property DirtyRegion As AnalysisRegion
'Usage
Dim instance As InkAnalyzer
Dim value As AnalysisRegion

value = instance.DirtyRegion

public AnalysisRegion DirtyRegion { get; }

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

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

public function get DirtyRegion () : AnalysisRegion

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. InkAnalyzer methods that add, remove, or update stroke data update the DirtyRegion. To manually mark an area for reanalysis, use the DirtyRegion object's Union method.

During a call, the Analyze or BackgroundAnalyze methods analyze ink within the DirtyRegion of the InkAnalyzer.

This property may contain nonadjacent areas.

Example

This example demonstrates user-initiated ink analysis within an application. An event handler, analyzeButton_Click, handles the user request for analysis results. The event handler performs analysis only if the InkAnalyzer object's DirtyRegion is not empty.

Sub analyzeButton_Click(ByVal sender As Object, ByVal e As RoutedEventArgs) 

    ' Only start ink analysis if the dirty region is not empty.
    If Not Me.theInkAnalyzer.DirtyRegion.IsEmpty Then
        ' Perform the ink analysis.
        Dim theStatus As AnalysisStatus = Me.theInkAnalyzer.Analyze()
        
        ' Update the analysis results on the form.
        Me.UpdateResults()
    End If

End Sub 'analyzeButton_Click

void analyzeButton_Click(object sender, RoutedEventArgs e)
{
    // Only start ink analysis if the dirty region is not empty.
    if (!this.theInkAnalyzer.DirtyRegion.IsEmpty)
    {
        // Perform the ink analysis.
        AnalysisStatus theStatus =
            this.theInkAnalyzer.Analyze();

        // Update the analysis results on the form.
        this.UpdateResults();
    }

}

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