Temporary |
Helper class to temporarily disable something, e.g. some events. By calling [M:SuspendGetToken] one gets a disposable token, that,
when disposed, enables again, which fires then the action that is given as parameter to the constructor. It is possible to make nested calls to [M:SuspendGetToken]. In this case all tokens
must be disposed before the [P:IsSuspended] is again true and the re-enabling action is fired.
Inheritance HierarchyNamespace: Altaxo.Main
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
SyntaxC#
public class TemporaryDisabler : SuspendableObject
The TemporaryDisabler type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | TemporaryDisabler | Constructor. You have to provide a callback function, that is been called when the event handling resumes. |
Properties| Name | Description | |
|---|---|---|
 | IsSuspended |
Gets a value indicating whether this instance is suspended.
(Inherited from SuspendableObject) |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnAboutToBeResumed |
Is called when the suspend level is still 1 (one), but is about to fall to zero, i.e. shortly before the call to OnResume. This function is not called before OnResumeSilently!
(Inherited from SuspendableObject) |
| OnResume |
Is called when the suppress level falls down from 1 to zero and the event count is != 0.
Per default, the resume event handler is called that you provided in the constructor.
(Overrides SuspendableObjectOnResume) |
| OnResumeSilently |
Is called when the suspend level falls down from 1 to zero by a call to ResumeSilently.
The implementation should delete any accumulated events, should also disarm the suspendTokens of the childs of this object, and should not fire any Changed events nor set the change state of the object to dirty.
(Inherited from SuspendableObject) |
| OnSuspended |
Called when the suspend level has just gone from 0 to 1, i.e. the object was suspended.
(Inherited from SuspendableObject) |
| Resume(ISuspendToken) |
Decrease the suspend level by disposing the suppress token. The token will fire the Resume event
if the suppress level falls to zero.
(Inherited from SuspendableObject) |
| Resume(ISuspendToken, EventFiring) |
Decrease the suspend level by disposing the suppress token. The token will fire the Resume event
if the suppress level falls to zero. You can suppress the resume event by setting argument 'suppressResumeEvent' to true.
(Inherited from SuspendableObject) |
| ResumeShortlyGetToken |
Resumes the events of this class as long as you hold the returned resume token. The original state (the suspenended state) is restored when you dispose the resume token.
(Inherited from SuspendableObject) |
| SuspendGetToken |
Increase the SuspendLevel by one, and return a token that, if disposed, will resume the object.
(Inherited from SuspendableObject) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
See Also