Click or drag to resize

IProxy Interface

Holds a reference to an object. If the object is part of the document, i.e. a document node (implements IDocumentLeafNode), then only a weak reference is held to this node, and special measures are used to track the node by its path. The path to the node is stored, and if a new document node with that path exists, the reference to the object is restored. IProxy can also hold non-document objects. To those objects a strong reference is established. The property DocumentPath then returns an empty path, and [M:ReplacePathParts] does nothing at all.

Namespace: Altaxo.Main
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
Syntax
C#
public interface IProxy : ICloneable

The IProxy type exposes the following members.

Properties
 NameDescription
Public propertyIsEmpty True when both the document is null and there is also no stored path to the document.
Top
Methods
 NameDescription
Public methodCloneCreates a new object that is a copy of the current instance.
(Inherited from ICloneable)
Public methodDocumentObject Returns the document node. If the stored doc node is null, it is tried to resolve the stored document path. If that fails too, null is returned.
Public methodDocumentPath Gets the path to the document, if the DocumentObject is or was part of the document. For non-document objects, an empty path is returned.
Public methodReplacePathParts This functionality is provided only for document nodes. For non-document nodes, this function does nothing. Replaces parts of the path of the document node by another part. If the replacement was successful, the original document node is cleared. See ReplacePathParts for details of the part replacement.
Top
See Also