FolderPath Class

FolderPath Class

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.

Inheritance Hierarchy

SystemObject
SandcastleBuilder.UtilsFilePath
SandcastleBuilder.UtilsFolderPath

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

Syntax

C++

Copy

[SerializableAttribute]
[TypeConverterAttribute(typeof(FolderPathTypeConverter))]
public class FolderPath : FilePath

<SerializableAttribute>
<TypeConverterAttribute(GetType(FolderPathTypeConverter))>
Public Class FolderPath
	Inherits FilePath

[SerializableAttribute]
[TypeConverterAttribute(typeof(FolderPathTypeConverter))]
public ref class FolderPath : public FilePath

[<SerializableAttribute>]
[<TypeConverterAttribute(typeof(FolderPathTypeConverter))>]
type FolderPath =  
    class
        inherit FilePath
    end

The FolderPath type exposes the following members.

Constructors

	Name	Description
	FolderPath(IBasePathProvider)	Default constructor. The folder path is undefined.
	FolderPath(String, IBasePathProvider)	Constructor. Assign the specified path.
	FolderPath(String, Boolean, IBasePathProvider)	Constructor. Assign the specified path and fixed setting.

Top

Methods

	Name	Description
	Clone	This returns a clone of the object (Inherited from FilePath.)
	Equals	This is overridden to allow proper comparison of file path objects. (Inherited from FilePath.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Get a hash code for the file path object (Inherited from FilePath.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsPathTerminated	This can be used to find out if a path is terminated with a trailing backslash.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnPersistablePathChanged	This raises the PersistablePathChanged event (Inherited from FilePath.)
	OnPersistablePathChanging	This raises the PersistablePathChanging event (Inherited from FilePath.)
	TerminatePath	This can be used to ensure that a path is terminated with a trailing backslash.
	ToString	Convert the file path to a string (Inherited from FilePath.)

Top

Properties

	Name	Description
	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. (Overrides FilePathExists.)
	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. (Overrides FilePathPath.)
	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.)

Top

Events

	Name	Description
	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.)

Top

Reference

SandcastleBuilder.Utils Namespace