FilePath.Path Property

FilePathPath Property

This is used to get or set the path to use.

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public virtual string Path { get; set; }

Public Overridable Property Path As String
	Get
	Set

public:
virtual property String^ Path {
	String^ get ();
	void set (String^ value);
}

abstract Path : string with get, set
override Path : string with get, set

Property Value

Type: 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.

If set to a null or empty string, the file path is cleared and is considered to be undefined.

Examples

C++

Copy

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

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

Reference

FilePath Class

SandcastleBuilder.Utils Namespace