InkAnalyzer.DirtyRegion Property

Article
12/12/2007

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

Namespace: Microsoft.Ink
Assembly: Microsoft.Ink.Analysis (in microsoft.ink.analysis.dll)

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. All of the 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.

Only ink within the DirtyRegion of the InkAnalyzer is analyzed during a call to the Analyze or BackgroundAnalyze method.

This property may contain nonadjacent areas.

Example

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

''' <summary>
''' The Analyze menu item's Click event handler.
''' </summary>
''' <param name="sender">The source of the event.</param>
''' <param name="e">The event data.</param>
Private Sub theInkAnalyzeMenuItem_Click( _
    ByVal sender As System.Object, ByVal e As System.EventArgs) _
    Handles theInkAnalyzeMenuItem.Click

    ' 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 Microsoft.Ink.AnalysisStatus = _
            Me.theInkAnalyzer.Analyze()

        ' Update the analysis results on the form.
        Me.UpdateResults(theStatus)
    End If

End Sub 'theInkAnalyzeMenuItem_Click

/// <summary>
/// The Ink menu's Analyze menu item's Click event handler.
/// </summary>
/// <param name="sender">The source of the event.</param>
/// <param name="e">The event data.</param>
private void theInkAnalyzeMenuItem_Click(object sender, EventArgs e)
{
    // Only start ink analysis if the dirty region is not empty.
    if (!this.theInkAnalyzer.DirtyRegion.IsEmpty)
    {
        // Perform the ink analysis.
        Microsoft.Ink.AnalysisStatus theStatus =
            this.theInkAnalyzer.Analyze();

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

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