DirectoryHelper Class

Directory management methods.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<DirectoryHelper>
        CMS.IO.DirectoryHelper

Namespace: CMS.IO
Assembly: CMS.IO (in CMS.IO.dll) Version: 8.2.23

Syntax

public class DirectoryHelper : AbstractHelper<DirectoryHelper>

The DirectoryHelper type exposes the following members.

Constructors

	Name	Description
Public method	DirectoryHelper

Methods

	Name	Description
Public method Static member	CombinePath	Combines parts of one path together, handles back slashes. Path ends without backslash.
Protected method	CombinePathInternal	Combines parts of one path together, handles back slashes.
Public method Static member	CopyDirectory	Copies specified directory including its subdirectories and all underlying files.
Protected method	CopyDirectoryInternal	Copies specified directory including its subdirectories and all underlying files.
Public method Static member	CopyFile	Copies the file.
Protected method	CopyFileInternal	Copies the file.
Public method Static member	CreateDirectory	Creates directory. It works also in a shared hosting environment.
Protected method	CreateDirectoryInternal	Creates directory. It works also in a shared hosting environment.
Public method Static member	DeleteDirectory(String)	Deletes the directory. It works also in a shared hosting environment.
Public method Static member	DeleteDirectory(String, Boolean)	Deletes the directory. It works also in a shared hosting environment.
Protected method	DeleteDirectoryInternal(String)	Deletes the directory. It works also in a shared hosting environment.
Protected method	DeleteDirectoryInternal(String, Boolean)	Deletes the directory. It works also in a shared hosting environment.
Public method Static member	DeleteDirectoryStructure	Deletes the directory structure. It works also in a shared hosting environment.
Protected method	DeleteDirectoryStructureInternal	Deletes the directory structure. It works also in a shared hosting environment.
Public method Static member	EnsureDiskPath	Checks if all folders of the given path exist and if not, it creates them.
Protected method	EnsureDiskPathInternal	Checks if all folders of the given path exist and if not, it creates them.
Public method Static member	EnsurePathBackSlash	This method ensures that path will end with one backslash.
Protected method	EnsurePathBackSlashInternal	This method ensures that path will end with one backslash.
Public method Static member	CheckPermissions(String)	Check permissions (checks read and write permissions).
Public method Static member	CheckPermissions(String, Boolean, Boolean, Boolean, Boolean)	Check write permissions.
Protected method	CheckPermissionsInternal	Check write permissions.
Public method Static member	MoveDirectory	Moves specified directory to new path.
Protected method	MoveDirectoryInternal	Moves specified directory to new path.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property Static member	AllowCheckIOPermissions	Allow checking IO permissions?
Public property Static member	IsWebRootWritable	Returns whether web root is writable.