FolderPath.Path Property

Definition

Namespace

Sandcastle.Core

Assembly

Sandcastle.Core.dll

This is used to get or set the path.

public override string Path { get; set; }

Property Value

string

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.

Examples

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\";

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\"