InkAnalyzer.InkAnalyzerStateChanging Event

Article
12/12/2007

Occurs before the InkAnalyzer reconciles analysis results so that an application can synchronize data with the InkAnalyzer.

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

Syntax

'Declaration
Public Event InkAnalyzerStateChanging As InkAnalyzerStateChangingEventHandler
'Usage
Dim instance As InkAnalyzer
Dim handler As InkAnalyzerStateChangingEventHandler

AddHandler instance.InkAnalyzerStateChanging, handler

public event InkAnalyzerStateChangingEventHandler InkAnalyzerStateChanging

public:
event InkAnalyzerStateChangingEventHandler^ InkAnalyzerStateChanging {
    void add (InkAnalyzerStateChangingEventHandler^ value);
    void remove (InkAnalyzerStateChangingEventHandler^ value);
}

/** @event */
public void add_InkAnalyzerStateChanging (InkAnalyzerStateChangingEventHandler value)

/** @event */
public void remove_InkAnalyzerStateChanging (InkAnalyzerStateChangingEventHandler value)

In JScript, you can handle the events defined by a class, but you cannot define your own.

Not applicable.

Remarks

Use this event when your application maintains its own data structure, which is synchronized with that of the InkAnalyzer. When the InkAnalyzer raises the InkAnalyzerStateChanging event, your application should populate the SubNodes property of the InkAnalyzer object's RootNode. During the reconcile phase, the InkAnalyzer uses this information as it parses and performs recognition of the ink.

The InkAnalyzer raises this event after it raises the ReadyToReconcile event. It raises this event only while performing background analysis.

Lock your data structure when the ink analyzer raises the InkAnalyzerStateChanging event. Changes to your data structure during this phase of analysis can cause errors in ink analysis and synchronization. You can unlock your data structure when the ink analyzer raises the IntermediateResults or Results event.

For more information about synchronizing your application data with the InkAnalyzer, see Data Proxy with Ink Analysis.

Example

This example defines a method, AttachDataProxyEventHandlers, that attaches data proxy event handlers to an InkAnalyzer, theInkAnalyzer.

Private Sub AttachDataProxyEventHandlers() 
    ' If the document model supports on demand data proxy, then add an
    ' event handler for the PopulateContextNode event. This event is raised
    ' when the InkAnalyzer accesses a partially populated ContextNode created
    ' by the document model.
    If Me.theDocumentModel.SupportsOnDemandDataProxy Then
        AddHandler Me.theInkAnalyzer.PopulateContextNode, AddressOf Me.PopulateContextNode
    End If
    
    ' Add the other data proxy related event handlers. These events are raised
    ' by the InkAnalyzer to communicate ink analysis results to the document model.
    AddHandler Me.theInkAnalyzer.ContextNodeCreated, AddressOf Me.AddContextNode
    AddHandler Me.theInkAnalyzer.ContextNodeDeleting, AddressOf Me.RemoveContextNode
    AddHandler Me.theInkAnalyzer.ContextNodeLinkAdding, AddressOf Me.AddContextNodeLink
    AddHandler Me.theInkAnalyzer.ContextNodeLinkDeleting, AddressOf Me.RemoveContextNodeLink
    AddHandler Me.theInkAnalyzer.ContextNodeMovingToPosition, AddressOf Me.MoveContextNodeToPosition
    AddHandler Me.theInkAnalyzer.ContextNodePropertiesUpdated, AddressOf Me.UpdateContextNodeProperties
    AddHandler Me.theInkAnalyzer.ContextNodeReparenting, AddressOf Me.ReparentContextNode
    AddHandler Me.theInkAnalyzer.InkAnalyzerStateChanging, AddressOf Me.InkAnalyzer_StateChanging
    AddHandler Me.theInkAnalyzer.StrokesReparented, AddressOf Me.ReparentStrokes
    AddHandler Me.theInkAnalyzer.IntermediateResultsUpdated, AddressOf Me.ResultsAvailable
    AddHandler Me.theInkAnalyzer.ResultsUpdated, AddressOf Me.ResultsAvailable

End Sub 'AttachDataProxyEventHandlers

private void AttachDataProxyEventHandlers()
{
    // If the document model supports on demand data proxy, then add an
    // event handler for the PopulateContextNode event. This event is raised
    // when the InkAnalyzer accesses a partially populated ContextNode created
    // by the document model.
    if (this.theDocumentModel.SupportsOnDemandDataProxy)
    {
        this.theInkAnalyzer.PopulateContextNode +=
            new PopulateContextNodeEventHandler(
                this.PopulateContextNode);
    }

    // Add the other data proxy related event handlers. These events are raised
    // by the InkAnalyzer to communicate ink analysis results to the document model.
    this.theInkAnalyzer.ContextNodeCreated +=
        new ContextNodeCreatedEventHandler(
            this.AddContextNode);
    this.theInkAnalyzer.ContextNodeDeleting +=
        new ContextNodeDeletingEventHandler(
            this.RemoveContextNode);
    this.theInkAnalyzer.ContextNodeLinkAdding +=
        new ContextNodeLinkAddingEventHandler(
            this.AddContextNodeLink);
    this.theInkAnalyzer.ContextNodeLinkDeleting +=
        new ContextNodeLinkDeletingEventHandler(
            this.RemoveContextNodeLink);
    this.theInkAnalyzer.ContextNodeMovingToPosition +=
        new ContextNodeMovingToPositionEventHandler(
            this.MoveContextNodeToPosition);
    this.theInkAnalyzer.ContextNodePropertiesUpdated +=
        new ContextNodePropertiesUpdatedEventHandler(
            this.UpdateContextNodeProperties);
    this.theInkAnalyzer.ContextNodeReparenting +=
        new ContextNodeReparentingEventHandler(
            this.ReparentContextNode);
    this.theInkAnalyzer.InkAnalyzerStateChanging +=
        new InkAnalyzerStateChangingEventHandler(
            this.InkAnalyzer_StateChanging);
    this.theInkAnalyzer.StrokesReparented +=
        new StrokesReparentedEventHandler(
            this.ReparentStrokes);
    this.theInkAnalyzer.IntermediateResultsUpdated +=
        new ResultsUpdatedEventHandler(
            this.ResultsAvailable);
    this.theInkAnalyzer.ResultsUpdated +=
        new ResultsUpdatedEventHandler(
            this.ResultsAvailable);
}

The following example defines the method, InkAnalyzer_StateChanging, that handles the InkAnalyzerStateChanging event. The event information is passed to the document model object, theDocumentModel.

This example does not provide the definition of the document model or demonstrate how it processes the information passed to it.

'/ <summary>
'/ Handles the InkAnalyzer.InkAnalyzerStateChanging event.
'/ </summary>
'/ <param name="sender">The source of the event.</param>
'/ <param name="e">The event data.</param>
Private Sub InkAnalyzer_StateChanging(ByVal sender As Object, ByVal e As System.EventArgs) 
    Me.theDocumentModel.BeginReconcilePhase()

End Sub 'InkAnalyzer_StateChanging

/// <summary>
/// Handles the InkAnalyzer.InkAnalyzerStateChanging event.
/// </summary>
/// <param name="sender">The source of the event.</param>
/// <param name="e">The event data.</param>
private void InkAnalyzer_StateChanging(object sender, System.EventArgs e)
{
    this.theDocumentModel.BeginReconcilePhase();
}

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