Home > Products > CSHTMLDiff Control > Documentation > User Guide
|
IsReady
|
Previous Top Next |
|
|
| Determines whether the current Diff-operation has finished and the control ready for navigation/reviewing method calls.
|
|
|
| Syntax
|
|
|
| Function IsReady() As Boolean
|
|
|
| Return Value
|
|
|
| True if the control is ready for Navigation/Reviewing method calls.
|
| False specifies that the control is busy processing the current Diff-Operation.
|
|
|
|
|
| Remarks
|
|
|
| No method calls should be made after calling DoDiff and before the result is available on screen.
|
| IsReady can be used to determine when it is safe to call methods on the control.
|
|
|
| During the short period of diff-processing, the control is unable to receive method calls because of its undetermined internal state. In this period, a call to IsReady will return False.
|
| On most occasions (when the results are available for manipulation) this method will return True.
|
|
|
| Important: In order to make your application wait for the IsReady function to return True, use the Timer event and not the Sleep event as this will cause the application to hang.
|
|
|
| If a developer plans on calling a method immediately after a DoDiff operation, it is strongly advised to verify that IsReady is True before doing so.
|