Sandcastle Help File Builder Documentation
Folder
This is used to get or set the path.
Definition
Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
When set, if the path is not rooted (a relative path), IsFixedPath is set to false. If rooted (an absolute path), it is not changed. This property always returns a fully qualified path but without any environment variable expansions and terminated with a trailing directory separator if needed. If set to a null or empty string, the folder path is cleared and is considered to be undefined.
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
C#
public override string Path { get; set; }VB
Public Overrides Property Path As String
Get
SetC++
public:
virtual property String^ Path {
String^ get () override;
void set (String^ value) override;
}F#
abstract Path : string with get, set
override Path : string with get, setProperty Value
StringWhen set, if the path is not rooted (a relative path), IsFixedPath is set to false. If rooted (an absolute path), it is not changed. This property always returns a fully qualified path but without any environment variable expansions and terminated with a trailing directory separator if needed. If set to a null or empty string, the folder path is cleared and is considered to be undefined.
Example
C#
FolderPath path = new FolderPath();
// Set it to a relative path
path.Path = @"..\..\ProjectFolder";
// Set it to an absolute path
path.Path = @"C:\My Documents\ProjectDocs\";
// Set it to a path based on an environment variable
path.Path = @"%HOMEDRIVE%%HOMEPATH%\Favorites\";VB
Dim path As New FolderPath()
' Set it to a relative path
path.Path = "..\..\ProjectFolder"
' Set it to an absolute path
path.Path = "C:\My Documents\ProjectDocs\"
' Set it to a path based on an environment variable
path.Path = "%HOMEDRIVE%%HOMEPATH%\Favorites\"C++
No code example is currently available or this language may not be supported.F#
No code example is currently available or this language may not be supported.