Click or drag to resize

ISuspendToken Interface

Interface for a token that is used to suspend events. By creating such a token, the suspend level of the parent object is incremented by one. If the token is disposed, or by a call to Resume, the suspend level of the object is decremented by one. If the suspend level falls to zero, the events are enabled again.

Namespace: Altaxo.Main
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
Copy
public interface ISuspendToken : IDisposable

The ISuspendToken type exposes the following members.

Methods
 NameDescription
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable)
Public methodResume Decrements the suspend level of the parent object. If the suspend level falls to zero during this call, the resume function is called. The object should then resume all child objects, and then indicate that it has changed to its parent and to any other listeners of the Change event.
Public methodResume(EventFiring) Either resumes the parent object of this token (using Resume), or resumes silently (using ResumeSilently), depending on the provided argument.
Public methodResumeCompleteTemporarily Resumes the object suspended by this token completely for a short time.
Public methodResumeCompleteTemporarilyGetToken Resumes the object suspended by this token completely for the time the returned token is referenced and not disposed. The return value is another token that had 'absorbed' the suspend count of the object, resulting in a suspend count of the object of 0 (zero). When these other token is finally disposed, the suspend count of the object is increased again by the 'absorbed' suspend count.
Public methodResumeSilently Disarms this SuspendToken and decrements the suspend level of the parent object. If the suspend level falls to zero during this call, the resume function is not called. Instead, usually another function (e.g. ResumeSilently) is called on the parent object to indicate that the object should be resumed without notifying that the object has changed.
Top
See Also