Sandcastle Help File Builder Documentation
File
This is used to get or set the path to use.
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. If set to a null or empty string, the file path is cleared and is considered to be undefined.
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
C#
public virtual string Path { get; set; }VB
Public Overridable Property Path As String
Get
SetC++
public:
virtual property String^ Path {
String^ get ();
void set (String^ value);
}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. If set to a null or empty string, the file path is cleared and is considered to be undefined.
Example
C#
FilePath path = new FilePath();
// Set it to a relative path
path.Path = @"..\..\Test.txt";
// Set it to an absolute path
path.Path = @"C:\My Documents\Info.doc";
// Set it to a path based on an environment variable
path.Path = @"%HOMEDRIVE%%HOMEPATH%\Favorites\*.*";VB
Dim path As New FilePath()
' Set it to a relative path
path.Path = "..\..\Test.txt"
' Set it to an absolute path
path.Path = "C:\My Documents\Info.doc"
' 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.