Project |
Immutable class that holds a project folder name. Note that the root folder name is an empty string, and
that all other folders have to end with an DirectorySeparatorChar. This rule also holds when splitting a full folder name into
parts: the parts also have to end with a DirectorySeparatorChar or have to be the empty string.
Inheritance HierarchyNamespace: Altaxo.Main
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3179.0 (4.8.3179.0)
SyntaxC#
public class ProjectFolder : INamedObject
The ProjectFolder type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ProjectFolder | Creates a project folder with the given name. |
Properties| Name | Description | |
|---|---|---|
 | IsRootFolder | Returns true if the folder name is the root folder (empty string). |
| Name | Gets the full folder name. The root folder is represented by an empty string. All other returned names end with an DirectorySeparatorChar. |
 | RootFolder | Returns the root folder instance. |
| RootFolderName | Gets the string that is associated with the root folder (here: an empty string). |
Methods| Name | Description | |
|---|---|---|
| AppendToName | Appends a string to a full name (by appending to the name part only). |
| AreAllNamesFromOneFolder | Determines whether all names in argument itemNames are from a single project folder. |
| Combine | Combines a folder name (with trailing DirectorySeparatorChar) with an item name, returning the full name of the item. If the trailing DirectorySeparatorChar is missed in the directoryPart, it is automatically appended to the directoryPart. |
| ConvertDisplayFolderNameToFolderName | Converts a string that was used by the Gui or entered by the user (and contains no trailing DirectorySeparatorChar) to a valid folder name. |
| ConvertFolderNameToDisplayFolderLastPart | Converts a folder name (i.e. either an empty string or a string with a trailing DirectorySeparatorChar) to a name which can be used to display. Only the last part of the folder name is returned here. |
| ConvertFolderNameToDisplayFolderName | Converts a folder name (i.e. either an empty string or a string with a trailing DirectorySeparatorChar) to a name which can be used to display on the display. |
| CreateFullName | Creates a new name starting from a oldfullNameOrDir and a newName. Retrieves the directory information from the oldFullNameOrDir and combines it with the newName to form a new full name. |
| Equals | (Overrides ObjectEquals(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) |
| GetCommonFolderOfNames | Gets the common folder of the provided item names. |
| GetFolderPart | Gets the directory part of a full qualified name. Can either be the name of an item (worksheet, graph) or a full folder name. If the name of a item is provided, the item's directory name is returned. If a full folder path is provided (i.e. either an empty string or a string ending with a DirectorySeparatorChar), the unchanged argument is returned. |
| GetFolderPartWithoutTrailingDirectorySeparatorChar | Intended for scripting purposes only! Gets the directory part of a full qualified name, but without the trailing DirectorySeparatorChar. No exception is thrown if the directory part is the root folder, thus the names '\Alice' and 'Alice' both return an empty string. The full qualified name can either be the name of an item (worksheet, graph) or a full folder name. If the name of a item is provided, the item's directory name (without trailing DirectorySeparatorChar) is returned. If a full folder path is provided (i.e. either an empty string or a string ending with a DirectorySeparatorChar), the name of the parent folder (without trailing DirectorySeparatorChar) is returned. |
 | GetFoldersLastFolderPart | Returns the name of the last folder from a folder path of arbitrary depth. |
| GetFoldersParentFolder | Gets the parent directory of the provided directory. |
| GetHashCode | (Overrides ObjectGetHashCode) |
| GetNamePart | Gets the name portion of a full name. Can either be the name of an item (worksheet, graph) or a full folder name. If the name of a item (worksheet or graph) is provided, the item's name without folder name is returned (thus containing no DirectorySeparatorChar)directory name is returned. If a full folder path is provided (i.e. either an empty string or a string ending with a DirectorySeparatorChar), the name of the last folder of the full folder path (!) is returned. |
| GetRelativePathFromTo | Gets the relative path from one folder to another folder. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| IsRootFolderName | Determines if the given string is the name of the root folder. |
| IsValidFolderName | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| PrependToName | Prepends a string to a full name (by prepending to the name part only). |
| ResolveRelativeDirectoryChars | Resolves the relative directory chars (.) and (..). |
| SplitFolderIntoParentFolderAndLastFolderPart | Splits a full folder name name into the parent directory and the single directory name. |
| SplitIntoFolderAndNamePart | Splits into directory and name portion of a full name. The full name can either be the name of an item (worksheet, graph) or a full folder name. If the name of a item (worksheet or graph) is provided, it is splitted into the item's folder name and the item's name. If a full folder path is provided (i.e. either an empty string or a string ending with a DirectorySeparatorChar), it is splitted into the name of the parent folder and the name of the last folder. |
| ThrowExceptionOnInvalidFullFolderPath | Test for the validity of a folder name of any level. The argument folderPath either has to be an empty string (representing the root folder) or a string ending with a directory separator char. If the argument is null, an ArgumentNullException is thrown. Otherwise, if the provided string is not a valid folder path, a ArgumentException will be thrown. |
| ThrowExceptionOnInvalidSingleFolderName | Test for the validity of a single folder name. The folderName either has to be an empty string (representing the root folder) or a string ending with a directory separator char and containing no other directory separator chars. If the string is null, an ArgumentNullException is thrown. Otherwise, if the provided string is not a valid folder name, a ArgumentException will be thrown. |
| ToString | (Overrides ObjectToString) |
| TryGetName | Test if this item already has a name. |
Fields| Name | Description | |
|---|---|---|
 | DirectorySeparatorChar | Char used to separate project subfolders. |
| DirectorySeparatorString | Char used to separate project subfolders, here as a string for convenience.. |
Extension Methods| Name | Description | |
|---|---|---|
 | ImportFilesIntoSeparateNewTables |
Imports multiple Ascii files into newly created new tables (each file into a separate table). The tables are named and stored in the project file in the provided project folder.
(Defined by AsciiImporter) |
| ImportFilesIntoSeparateNewTables |
Imports multiple Ascii files into newly created new tables (each file into a separate table). The tables are named and stored in the project file in the provided project folder.
(Defined by AsciiImporter) |
| ImportFilesIntoSeparateNewTables |
Imports multiple Ascii files into newly created new tables (each file into a separate table). The tables are named and stored in the project file in the provided project folder.
(Defined by AsciiImporter) |
See Also