ActivityEventHandler Delegate

Article
10/19/2012

Represents the method that will handle the Activity event of an InkAnalyzer.

Namespace: Microsoft.Ink
Assembly: Microsoft.Ink.Analysis (in Microsoft.Ink.Analysis.dll)

Syntax

'Declaration
Public Delegate Sub ActivityEventHandler ( _
    sender As Object, _
    e As EventArgs _
)
'Usage
Dim instance As New ActivityEventHandler(AddressOf HandlerMethod)

public delegate void ActivityEventHandler(
    Object sender,
    EventArgs e
)

public delegate void ActivityEventHandler(
    Object^ sender, 
    EventArgs^ e
)

JScript does not support delegates.

Parameters

sender
Type: System.Object

The source InkAnalyzer object for this event.

e
Type: System.EventArgs

The event data.

Remarks

When you create an ActivityEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event-handler delegates, see Events and Delegates.

Authored: January 27th, 2009

Examples

This example defines an event handler for the ink analyzer's Activity event. If the analysis operation should be canceled, the event handler calls Abort on the InkAnalyzer that generated the event and updates the analyzer's DirtyRegion property.

''' <summary> 
''' The ink analyzer's Activity event handler. 
''' </summary> 
''' <param name="sender">The source of the event.</param> 
''' <param name="e">The event data.</param> 
Sub theInkAnalyzer_Activity(ByVal sender As Object, ByVal e As EventArgs)
    Dim abortAnalysis As Boolean = False 

    ' Check if the analysis operation should be canceled. 
    ' Abort analysis if the flag to do so is set. 
    If abortAnalysis Then 
        ' Get the InkAnalyzer that raised the Activity event. 
        Dim theInkAnalyzer As Microsoft.Ink.InkAnalyzer = _
            DirectCast(sender, Microsoft.Ink.InkAnalyzer)

        ' Abort the analysis and get the region that was being analyzed. 
        Dim theAnalysisRegion As Microsoft.Ink.AnalysisRegion = _
            theInkAnalyzer.Abort()

        ' Add the region that was being analyzed to the analyzer's dirty region.
        theInkAnalyzer.DirtyRegion.Union(theAnalysisRegion)
    End If 

End Sub 'theInkAnalyzer_Activity

/// <summary> 
/// The ink analyzer's Activity event handler. 
/// </summary> 
/// <param name="sender">The source of the event.</param>
/// <param name="e">The event data.</param>
void theInkAnalyzer_Activity(object sender, EventArgs e)
{
    bool abortAnalysis = false;

    // Check if the analysis operation should be canceled. 

    // Abort analysis if the flag to do so is set. 
    if (abortAnalysis)
    {
        // Get the InkAnalyzer that raised the Activity event.
        Microsoft.Ink.InkAnalyzer theInkAnalyzer =
            sender as Microsoft.Ink.InkAnalyzer;

        // Abort the analysis and get the region that was being analyzed.
        Microsoft.Ink.AnalysisRegion theAnalysisRegion = theInkAnalyzer.Abort();

        // Add the region that was being analyzed to the analyzer's dirty region.
        theInkAnalyzer.DirtyRegion.Union(theAnalysisRegion);
    }
}

Platforms

Windows 7, Windows Vista, Windows Server 2008 R2, Windows Server 2008

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

Share via