Absolute |
DocumentPath holds a path to a document. This path reflects the internal organization of the class instances in Altaxo. Do not mix this
concept with the concept of the folder in which a project item virtually exists (see ProjectFolder).
Inheritance HierarchyNamespace: Altaxo.Main
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3572.0 (4.8.3572.0)
SyntaxC#
[SerializableAttribute] public sealed class AbsoluteDocumentPath : ICloneable
The AbsoluteDocumentPath type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AbsoluteDocumentPath(AbsoluteDocumentPath) | Initializes a new instance of the AbsoluteDocumentPath class by copying another instance. |
| AbsoluteDocumentPath(IEnumerableString) | Initializes a new instance of the AbsoluteDocumentPath class from an enumeration of path parts. |
Properties| Name | Description | |
|---|---|---|
 | Count | Gets the number of path parts. |
| Item | Gets the path part at the specified index. |
| LastPart | Gets the last part, which is often the name of the object. |
| LastPartOrDefault | Gets the last part, which is often the name of the object. |
| ParentPath | Gets the parent path of the current path. The parent path contains all parts except for the last part. |
Methods| Name | Description | |
|---|---|---|
| Append(AbsoluteDocumentPath) | Appends another absolute document path. |
| Append(String) | Appends a single path part. |
| Clone | Creates a copy of this path. |
| Equals | Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(Object)) |
 | FromPathString | Creates an absolute document path from its string representation. |
| GetAbsolutePath |
Get the absolute path of the node node starting from the root.
|
| GetHashCode | Serves as the default hash function. (Overrides ObjectGetHashCode) |
| GetNodeOrLeastResolveableNode | Gets the node that is designated by the provided path or the least resolveable node. |
| GetObject(AbsoluteDocumentPath, IDocumentLeafNode) | Resolves the specified path starting from the root node of startnode. |
| GetObject(AbsoluteDocumentPath, IDocumentLeafNode, IDocumentNode) | Resolves the path by first using startnode as starting point. If that failed, try using documentRoot as starting point. |
| GetPath |
Get the absolute path of the node node starting either from the root, or from the object in the depth
maxDepth, whatever is reached first.
|
| GetPathString | Gets the string representation of the path of the specified node. |
| GetRootNode |
Get the root node of the node node. The root node is defined as last node in the hierarchie that
either has not implemented the IDocumentLeafNode interface or has no parent.
|
| GetRootNodeImplementing(IDocumentLeafNode, Type) |
Get the first parent node of the node node that implements the given type type..
|
| GetRootNodeImplementingT(IDocumentLeafNode) | Gets the first parent node of node that implements T. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| ReplaceLastPart | Replaces the last part of the AbsoluteDocumentPath, which is often the name of the object. |
| ReplacePathParts | Replaces parts of the part by another part. |
| StartsWith | Determines whether this path starts with the specified path. |
| SubPath | Returns a subpath. |
| ToString | Returns a string that represents the current object. (Overrides ObjectToString) |
| TryGetAbsolutePath |
Get the absolute path of the node node starting from the root, or null if that fails.
|
Fields| Name | Description | |
|---|---|---|
 | DocumentPathOfRootNode | The document path of the root node. |
See Also