Share via


InkAnalyzer.Reconcile Method (Int64)

Performs InkAnalyzer reconcilation with a control over how long a reconcile operation takes.

Namespace:  Microsoft.Ink
Assembly:  Microsoft.Ink.Analysis (in Microsoft.Ink.Analysis.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 that the application is willing to wait for a transaction to complete. This is a guideline, not a strict constraint. Valid values are 0 - (max long / 10000). An ArgumentOutOfRange exception will be 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 have control over how long a reconcile operation takes on the UI thread. Calling reconcile with the timeLimit parameter will trigger a transaction that will run until the time limit has been reached or the changelist has been completed. The results event will only be fired when the changelist is complete.

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

PropertiesChanged events and StrokesReparented events will be cached until the end of a transaction and a single event will be raised before Reconcile returns.

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

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

See Also

Reference

InkAnalyzer Class

InkAnalyzer Members

Reconcile Overload

Microsoft.Ink Namespace