FolderPath Class

Definition

Namespace

Sandcastle.Core

Assembly

Sandcastle.Core.dll

This class is used to represent a folder path. Support is included for treating the path as fixed or relative and for expanding environment variables in the path name.

[Serializable]
[TypeConverter(typeof(FolderPathTypeConverter))]
public class FolderPath : FilePath, ICloneable

Inheritance

object

FilePath

FolderPath

Implements

ICloneable

Constructors

FolderPath(IBasePathProvider)	Default constructor. The folder path is undefined.
FolderPath(string, bool, IBasePathProvider)	Constructor. Assign the specified path and fixed setting.
FolderPath(string, IBasePathProvider)	Constructor. Assign the specified path.

Fields

DefaultOutDir	This defines the default OutDir MSBuild property value (.) (Inherited from FilePath)
PathAndWildcards	This defines the common path and wildcard characters (Inherited from FilePath)
RelativePathPrefix	This defines the relative path prefix (Inherited from FilePath)
Wildcards	This defines the common wildcard characters (Inherited from FilePath)

Properties

BasePath	This returns the base path for the object (Inherited from FilePath)
BasePathProvider	This is used to get the base path provider for the object. (Inherited from FilePath)
Exists	This read-only property can be used to determine whether or not the folder path exists
ExpandedPath	This read-only property is used to display the fully qualified path with environment variable expansions in the designer. (Inherited from FilePath)
IsFixedPath	This is used to indicate whether or not the path will be treated as a relative or fixed path when converted retrieved via the PersistablePath property. (Inherited from FilePath)
Path	This is used to get or set the path.
PersistablePath	This is used to retrieve the file path in a format suitable for persisting to storage based on the current settings. (Inherited from FilePath)

Methods

Clone()	This returns a clone of the object (Inherited from FilePath)
GetHashCode()	Get a hash code for the file path object (Inherited from FilePath)
IsPathTerminated(string)	This can be used to find out if a path is terminated with a trailing directory separator.
TerminatePath(string)	This can be used to ensure that a path is terminated with a trailing directory separator.
ToString()	Convert the file path to a string (Inherited from FilePath)

Events

PersistablePathChanged	This event is raised when the persistable path changes (Inherited from FilePath)
PersistablePathChanging	This event is raised when the persistable path is about to be changed (Inherited from FilePath)