InkAnalyzer.Reconcile Method (Int64)

Article
2012-10-19

Reconciles those portions of the analysis results that changed during background ink analysis in the specified amount of time.

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

Syntax

'Declaration
Public Function Reconcile ( _
    timeLimit As Long _
) As Boolean
'Usage
Dim instance As InkAnalyzer 
Dim timeLimit As Long 
Dim returnValue As Boolean 

returnValue = instance.Reconcile(timeLimit)

public bool Reconcile(
    long timeLimit
)

public:
bool Reconcile(
    long long timeLimit
)

public function Reconcile(
    timeLimit : long
) : boolean

Parameters

timeLimit
Type: System.Int64

The length of time in milliseconds for which the application will wait to complete a transaction. This is a guideline, not a strict constraint. Valid values are 0 - (max long / 10000). An ArgumentOutOfRangeException exception is raised if this method is called with an invalid value.

Return Value

Type: System.Boolean
true if there is more to reconcile, false if reconciliation is complete.

Remarks

Users may wish to control how long a reconcile operation takes on the UI thread. Calling reconcile with the timeLimit parameter begins a transaction that runs either until the time limit is reached, or until the reconciliation between the background analysis and the InkAnalyzer is complete. The InkAnalyzer raises the ResultsUpdated event only if reconciliation is complete.

At the end of a transaction, the tree is guaranteed to be in a valid state. A valid state is defined by the following characteristics: no children without parents, and no parents without children. In other words, containers without nodes, and leaf nodes without strokes.

The StrokesReparented event is cached until the end of a transaction and a single event is raised before Reconcile returns.

At least one transaction is completed for each call to Reconcile that has a valid time parameter.

For more information on reconciling, see [M:System.Windows.Ink.InkAnalyzer.Reconcile.]

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

Share via