InkAnalyzer.PopulateContextNode Event

Article
10/19/2012

Occurs before the InkAnalyzer performs analysis within the region of a partially populated ContextNode.

Namespace: System.Windows.Ink
Assembly: IAWinFX (in IAWinFX.dll)

Syntax

'Declaration
Public Event PopulateContextNode As PopulateContextNodeEventHandler
'Usage
Dim instance As InkAnalyzer 
Dim handler As PopulateContextNodeEventHandler 

AddHandler instance.PopulateContextNode, handler

public event PopulateContextNodeEventHandler PopulateContextNode

public:
 event PopulateContextNodeEventHandler^ PopulateContextNode {
    void add (PopulateContextNodeEventHandler^ value);
    void remove (PopulateContextNodeEventHandler^ value);
}

JScript does not support events.

Remarks

Use this event when your application maintains its own data structure, which is synchronized with that of the InkAnalyzer. When the InkAnalyzer raises this event, your application should populate the PopulateContextNodeEventArgs.NodeToPopulate property. During the analysis phase, the InkAnalyzer raises this event to get information for areas where it is analyzing ink.

If the document contains links for the NodeToPopulate property, your application should create and add these links. This process requires that both the source and destination nodes and their ancestors are fully populated before the event handler for this event exits.

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

During background analysis, the InkAnalyzer raises this event after it raises the InkAnalyzerStateChanging event.

Examples

This example defines a method, AttachDataProxyEventHandlers, that attaches data proxy event handlers to an InkAnalyzer named 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, PopulateContextNode, that handles the PopulateContextNode event. The event information is passed to the document model object (named 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.PopulateContextNode event. 
'/ </summary> 
'/ <param name="sender">The source of the event.</param> 
'/ <param name="e">The event data.</param> 
'/ <remarks> 
'/ This event handler fully populates a ContextNode from the document model. 
'/ The InkAnalyzer calls this event handler when it accesses a partially 
'/ populated ContextNode created by the document model. 
'/ </remarks> 
Private Sub PopulateContextNode(ByVal sender As Object, ByVal e As PopulateContextNodeEventArgs) 
    Me.theDocumentModel.PopulateNode(e.NodeToPopulate, CType(sender, InkAnalyzer))

End Sub 'PopulateContextNode

        /// <summary> 
        /// Handles the InkAnalyzer.PopulateContextNode event. 
        /// </summary> 
        /// <param name="sender">The source of the event.</param>
        /// <param name="e">The event data.</param>
        /// <remarks> 
        /// This event handler fully populates a ContextNode from the document model. 
        /// The InkAnalyzer calls this event handler when it accesses a partially 
        /// populated ContextNode created by the document model. 
        /// </remarks> 
        private void PopulateContextNode(
            object sender, PopulateContextNodeEventArgs e)
        {
            this.theDocumentModel.PopulateNode(
                e.NodeToPopulate, (InkAnalyzer)sender);
        }

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

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