Table of Contents

Class AbstractDirectory

Namespace
CMS.IO
Assembly
CMS.IO.dll

Abstract class for directory providers.

public abstract class AbstractDirectory
Inheritance
object
AbstractDirectory
Derived
Extension Methods

Constructors

AbstractDirectory() 

protected AbstractDirectory()

Methods

CreateDirectory(string)

Creates all directories and subdirectories as specified by path.

public abstract DirectoryInfo CreateDirectory(string path)

Parameters

path string

Path to create

Returns

DirectoryInfo

Delete(string)

Deletes an empty directory.

public abstract void Delete(string path)

Parameters

path string

Path to directory

Delete(string, bool)

Deletes an empty directory and, if indicated, any subdirectories and files in the directory.

public abstract void Delete(string path, bool recursive)

Parameters

path string

Path to directory

recursive bool

If delete if subdirs exists

DeleteDirectoryStructure(string)

Deletes all files in the directory structure. It works also in a shared hosting environment.

public abstract void DeleteDirectoryStructure(string path)

Parameters

path string

Full path of the directory to delete

EnumerateDirectories(string)

Returns an enumerable collection of directory names in a specified path.

public virtual IEnumerable<string> EnumerateDirectories(string path)

Parameters

path string

The relative or absolute path to the directory to search. This string is not case-sensitive.

Returns

IEnumerable<string>

An enumerable collection of the full names (including paths) for the directories in the directory specified by path.

Remarks

This method is identical to EnumerateDirectories(string, string) with the asterisk (*) specified as the search pattern, so it returns all subdirectories.

If you need to search subdirectories recursively, use the EnumerateDirectories(string, string, SearchOption) method, which enables you to specify a search of all subdirectories.

EnumerateDirectories(string, string)

Returns an enumerable collection of directory names that match a search pattern in a specified path.

public virtual IEnumerable<string> EnumerateDirectories(string path, string searchPattern)

Parameters

path string

The relative or absolute path to the directory to search. This string is not case-sensitive.

searchPattern string

Search pattern.

Returns

IEnumerable<string>

An enumerable collection of the full names (including paths) for the directories in the directory specified by path and that match the specified search pattern.

Remarks

If you need to search subdirectories recursively, use the EnumerateDirectories(string, string, SearchOption) method, which enables you to specify a search of all subdirectories.

EnumerateDirectories(string, string, SearchOption)

Returns an enumerable collection of directory names that match a search pattern in a specified path, and optionally searches subdirectories.

public abstract IEnumerable<string> EnumerateDirectories(string path, string searchPattern, SearchOption searchOption)

Parameters

path string

The relative or absolute path to the directory to search. This string is not case-sensitive.

searchPattern string

Search pattern.

searchOption SearchOption

One of the enumeration values that specifies whether the search operation should include only the current directory or should include all subdirectories.

Returns

IEnumerable<string>

An enumerable collection of the full names (including paths) for the directories in the directory specified by path and that match the specified search pattern and option.

EnumerateFiles(string)

Returns an enumerable collection of file names in a specified path.

public virtual IEnumerable<string> EnumerateFiles(string path)

Parameters

path string

The relative or absolute path to the directory to search. This string is not case-sensitive.

Returns

IEnumerable<string>

An enumerable collection of the full names (including paths) for the files in the directory specified by path.

Remarks

This method is identical to EnumerateFiles(string, string) with the asterisk (*) specified as the search pattern.

EnumerateFiles(string, string)

Returns an enumerable collection of file names that match a search pattern in a specified path.

public abstract IEnumerable<string> EnumerateFiles(string path, string searchPattern)

Parameters

path string

The relative or absolute path to the directory to search. This string is not case-sensitive.

searchPattern string

Search pattern.

Returns

IEnumerable<string>

An enumerable collection of the full names (including paths) for the files in the directory specified by path and that match the specified search pattern.

Exists(string)

Determines whether the given path refers to an existing directory on disk.

public abstract bool Exists(string path)

Parameters

path string

Path to test

Returns

bool

GetDirectories(string)

Returns the names of subdirectories (including their paths) in the specified directory.

public virtual string[] GetDirectories(string path)

Parameters

path string

The relative or absolute path to the directory to search. This string is not case-sensitive.

Returns

string[]

An array of the full names (including paths) of subdirectories in the specified path, or an empty array if no directories are found.

Remarks

This method is identical to GetDirectories(string, string) with the asterisk (*) specified as the search pattern, so it returns all subdirectories.

If you need to search subdirectories recursively, use the GetDirectories(string, string, SearchOption) method, which enables you to specify a search of all subdirectories.

GetDirectories(string, string)

Returns the names of subdirectories (including their paths) that match the specified search pattern in the specified directory.

public virtual string[] GetDirectories(string path, string searchPattern)

Parameters

path string

The relative or absolute path to the directory to search. This string is not case-sensitive.

searchPattern string

Search pattern.

Returns

string[]

An array of the full names (including paths) of the subdirectories that match the search pattern in the specified directory, or an empty array if no directories are found.

Remarks

If you need to search subdirectories recursively, use the GetDirectories(string, string, SearchOption) method, which enables you to specify a search of all subdirectories.

GetDirectories(string, string, SearchOption)

Gets the names of the subdirectories (including their paths) that match the specified search pattern in the current directory, and optionally searches subdirectories.

public abstract string[] GetDirectories(string path, string searchPattern, SearchOption searchOption)

Parameters

path string

The relative or absolute path to the directory to search. This string is not case-sensitive.

searchPattern string

Search pattern.

searchOption SearchOption

One of the enumeration values that specifies whether the search operation should include all subdirectories or only the current directory.

Returns

string[]

An array of the full names (including paths) of the subdirectories that match the specified criteria, or an empty array if no directories are found.

GetFiles(string)

Returns the names of files (including their paths) in the specified directory.

public virtual string[] GetFiles(string path)

Parameters

path string

The relative or absolute path to the directory to search. This string is not case-sensitive.

Returns

string[]

An array of the full names (including paths) for the files in the specified directory, or an empty array if no files are found.

Remarks

This method is identical to GetFiles(string, string) with the asterisk (*) specified as the search pattern.

GetFiles(string, string)

Returns the names of files (including their paths) that match the specified search pattern in the specified directory.

public abstract string[] GetFiles(string path, string searchPattern)

Parameters

path string

The relative or absolute path to the directory to search. This string is not case-sensitive.

searchPattern string

Search pattern.

Returns

string[]

An array of the full names (including paths) for the files in the specified directory that match the specified search pattern, or an empty array if no files are found.

GetSearchCondition(string)

Returns search condition delegate.

protected Func<string, bool> GetSearchCondition(string searchPattern)

Parameters

searchPattern string

Can be a combination of literal and wildcard characters, but doesn't support regular expressions. Supports only * and ?

Returns

Func<string, bool>

Move(string, string)

Moves a file or a directory and its contents to a new location.

public abstract void Move(string sourceDirName, string destDirName)

Parameters

sourceDirName string

Source directory name

destDirName string

Destination directory name

PrepareFilesForImport(string)

Prepares files for import. Converts them to media library.

[Obsolete("Method was not intended for public use and will be removed in the next version.")]
public abstract void PrepareFilesForImport(string path)

Parameters

path string

Path.