Relative |
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 RelativeDocumentPath : ICloneable, IImmutable
The RelativeDocumentPath type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | RelativeDocumentPath(RelativeDocumentPath) | Initializes a new instance of the RelativeDocumentPath class by copying another instance. |
| RelativeDocumentPath(Int32, IEnumerableString) | Initializes a new instance of the RelativeDocumentPath class. |
Properties| Name | Description | |
|---|---|---|
 | Count | Gets the number of stored path parts. |
| IsIdentity | Gets a value indicating whether this path represents the identity path. |
| Item | Gets the path part at the specified index. |
| NumberOfStepsDown | Gets the number of upward steps. |
Methods| Name | Description | |
|---|---|---|
| Clone | Creates a copy of this relative document path. |
| Equals | Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(Object)) |
 | FromOldDeprecated | Converts an older absolute-path representation into a relative document path. |
| 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 | Resolves the specified relative path starting from the given node. |
| GetRelativePathFromTo(IDocumentLeafNode, IDocumentLeafNode) |
Retrieves the relative path from the node startnode to the node endnode.
|
| GetRelativePathFromTo(IDocumentLeafNode, IDocumentLeafNode, IDocumentNode) |
Retrieves the relative path from the node startnode to the node endnode.
|
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Overrides ObjectToString) |
Fields| Name | Description | |
|---|---|---|
 | IdentityPath | The path that designates identity, i.e. the start node is identical to the destination node. |
See Also