FolderPath Class

HTML to MAML Converter

previous page next page
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: ConvertHtmlToMaml (in ConvertHtmlToMaml.exe) Version: 1.0.0.2
Syntax
Copy
[SerializableAttribute]
public class FolderPath : FilePath
<SerializableAttribute>
Public Class FolderPath
	Inherits FilePath
[SerializableAttribute]
public ref class FolderPath : public FilePath
[<SerializableAttribute>]
type FolderPath =  
    class
        inherit FilePath
    end

The FolderPath type exposes the following members.

Constructors
  NameDescription
Public methodFolderPath(IBasePathProvider)
Default constructor. The folder path is undefined.
Public methodFolderPath(String, IBasePathProvider)
Constructor. Assign the specified path.
Public methodFolderPath(String, Boolean, IBasePathProvider)
Constructor. Assign the specified path and fixed setting.
Top
Properties
  NameDescription
Public propertyBasePath
This returns the base path for the object
(Inherited from FilePath.)
Public propertyBasePathProvider
This is used to get the base path provider for the object.
(Inherited from FilePath.)
Public propertyExists
This read-only property can be used to determine whether or not the folder path exists.
(Overrides FilePathExists.)
Public propertyExpandedPath
This read-only property is used to display the fully qualified path with environment variable expansions in the designer.
(Inherited from FilePath.)
Public propertyIsFixedPath
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.)
Public propertyCode examplePath
This is used to get or set the path.
(Overrides FilePathPath.)
Public propertyPersistablePath
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
Methods
  NameDescription
Public methodClone
This returns a clone of the object
(Inherited from FilePath.)
Public methodEquals
This is overridden to allow proper comparison of file path objects.
(Inherited from FilePath.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Get a hash code for the file path object
(Inherited from FilePath.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberIsPathTerminated
This can be used to find out if a path is terminated with a trailing backslash.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnPersistablePathChanged
This raises the PersistablePathChanged event
(Inherited from FilePath.)
Protected methodOnPersistablePathChanging
This raises the PersistablePathChanging event
(Inherited from FilePath.)
Public methodStatic memberTerminatePath
This can be used to ensure that a path is terminated with a trailing backslash.
Public methodToString
Convert the file path to a string
(Inherited from FilePath.)
Top
Events
  NameDescription
Public eventPersistablePathChanged
This event is raised when the persistable path changes
(Inherited from FilePath.)
Public eventPersistablePathChanging
This event is raised when the persistable path is about to be changed
(Inherited from FilePath.)
Top
See Also
previous page start next page