Click or drag to resize

SuspendableDocumentNodeBase Class

[Missing <summary> documentation for "T:Altaxo.Main.SuspendableDocumentNodeBase"]

Inheritance Hierarchy
SystemObject
  Altaxo.MainSuspendableDocumentNodeBase
    Altaxo.MainSuspendableDocumentLeafNode
    Altaxo.MainSuspendableDocumentNode

Namespace: Altaxo.Main
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
public abstract class SuspendableDocumentNodeBase : IDocumentLeafNode, 
	INamedObject, IChangedEventSource, ISuspendableByToken, ITunnelingEventSource, IDisposable, 
	ITreeNodeWithParent<IDocumentLeafNode>, ITreeNode<IDocumentLeafNode>, INodeWithParentNode<IDocumentLeafNode>

The SuspendableDocumentNodeBase type exposes the following members.

Constructors
 NameDescription
Protected methodSuspendableDocumentNodeBaseInitializes a new instance of the SuspendableDocumentNodeBase class
Top
Properties
 NameDescription
Protected propertyAccumulatedEventData Gets the accumulated event data.
Protected propertyDebug_AbsolutePath Gets the absolute path of the node for debugging purposes.
Public propertyIsDisposed Gets a value indicating whether this instance is disposed.
Public propertyIsDisposeInProgress Gets a value indicating whether for this instance dispose is in progress, or the instance is already disposed.
Public propertyIsSomeoneListeningToChanges Gets a value indicating whether someone is listening to changes. For this, either the ParentObject or the Changed event must be set.
Public propertyIsSuspended Gets a value indicating whether this instance is suspended.
Public propertyName Gets the name of this document node. Null is returned if the name is not set or unknown. The set accessor will for most nodes throw a InvalidOperationException, since the name can only be set on IProjectItems.
Public propertyParentObject Gets/sets the parent object this instance belongs to.
Top
Methods
 NameDescription
Protected methodAccumulateChangeData Accumulates the change event data of the child.
Protected methodAccumulatedChangeData_SetBackAfterResumeAndSuspend Sets the change data without further processing. This function is infrastructure and intended to use only in OnResume after the parent has suspended this node again. That's why it is presumed that the accumulated event data is empty when this function is called.
Protected methodAccumulatedEventData_Clear Clears the accumulated event data.
Protected methodAccumulatedEventData_HasZeroOrOneEventArg Determines whether there is no or only one single event arg accumulated. If this is the case, the return value is true. If there is one event arg accumulated, it is returned in the argument singleEventArg. The return value is false if there is more than one event arg accumulated. In this case the singleEventArg is null on return, and the calling function should use AccumulatedEventData to enumerate all accumulated event args.
Protected methodChildDisposeMemberT Helper function to dispose a child node of this instance. It helps to ensure the correct order: first, the child node is set to null and only then the child node is disposed.
Public methodDispose Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Protected methodDispose(Boolean) Releases unmanaged and - optionally - managed resources.
Public methodEhParentTunnelingEventHappened Is called by the parent when a tunneling event happened into the parent.
Protected methodEhSelfChanged Is called by this instance if anything inside this member changed.
Public methodEhSelfTunnelingEventHappened(TunnelingEventArgs) Is called by this instance if a tunneling event happened into this instance. The tunneling event triggers the TunneledEvent and is additionally distributed to all childs of this instance.
Public methodEhSelfTunnelingEventHappened(TunnelingEventArgs, Boolean) Is called by this instance if a tunneling event happened into this instance. The tunneling event triggers the TunneledEvent and is - depending on the provided parameter - also distributed to all childs of this instance.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Finalizes an instance of the SuspendableDocumentNodeBase class.
(Overrides ObjectFinalize)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnChanged Fires the change event with the EventArgs provided in the argument.
Protected methodOnTunnelingEvent Fires the TunneledEvent event.
Public methodStatic memberReportNotConnectedDocumentNodes Reports not connected document nodes, i.e. child nodes having no parent. This functionality is available only in DEBUG mode with TRACEDOCUMENTNODES defined in AltaxoBase.
Public methodResume(ISuspendToken) Resumes changed events by calling Resume for the provided suspend token, and setting the reference to the suspend token to null. If Event data were accumulated during the suspended state, a changed event is triggered for each event data.
Public methodResume(ISuspendToken, EventFiring) Resumes changed events, either with taking the accumulated event data into account (see Resume(ISuspendToken)) or discarding the accumulated event data (see ResumeSilently(ISuspendToken), depending on the provided argument eventFiring.
Public methodResumeCompleteTemporarily Resumes the object completely for only a short time. Thus, if object was suspended before, it will be suspended again when the function returns.
Public methodResumeCompleteTemporarilyGetToken Resumes the object completely for the time the returned token is referenced and not disposed. The return value is a token that had 'absorbed' the suspend count of the object, resulting in the suspend count of the object dropped to 0 (zero). When the returned token is finally disposed, the suspend count of the object is increased again by the 'absorbed' suspend count.
Public methodResumeSilently Resumes changed events by calling Resume for the provided suspend token, and setting the reference to the suspend token to null. All event data accumulated during the suspended state are discarded, and thus no change event is triggered even if the instance has changed during the suspended state.
Public methodSetDisposeInProgress Sets the flag that dispose is in progress for this node and all child nodes recursively.
Protected methodSetMemberAndRaiseSelfChangedT(NullableT, NullableT) Sets a member variable of this instance and raise a change event with Empty if the new value is different from the old value. The comparison is done using the IEquatableT interface of the member variable. Note: to set members that implement IDocumentNode please use the Child... functions.
Protected methodSetMemberAndRaiseSelfChangedT(T, T) Sets a member variable of this instance and raise a change event with Empty if the new value is different from the old value. The comparison is done using the IEquatableT interface of the member variable. Note: to set members that implement IDocumentNode please use the Child... functions.
Protected methodSetMemberEnumAndRaiseSelfChangedT Sets a member variable (which is an Enum) of this instance and raise a change event with Empty if the new value is different from the old value. The comparison is done using the IEquatableT interface of the member variable. Note: to set members that implement IDocumentNode please use the Child... functions.
Public methodSuspendGetToken Increase the SuspendLevel by one, and return a token that, if disposed, will resume the object.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodTryGetName Test if this item already has a name.
Top
Events
 NameDescription
Public eventChangedFired when something in the object has changed, and the object is not suspended.
Public eventTunneledEvent The event that is fired when the object is disposed. First argument is the sender, second argument is the original source, and third argument is the event arg.
Top
Fields
 NameDescription
Protected field_parent The parent object this instance belongs to.
Top
Extension Methods
 NameDescription
Public Extension MethodGetPropertyContext Gets the property context of the document node. If the provided node is not implementing IPropertyBagOwner, the parent nodes of this node are searched, until a node which implements IPropertyBagOwner is found.
(Defined by PropertyExtensions)
Top
See Also