Class Path

Namespace

CMS.IO

Assembly

CMS.IO.dll

Performs operations on String instances that contain file or directory path information.

public static class Path

Inheritance

object

Path

Properties

AltDirectorySeparatorChar

Provides a platform-specific alternate character used to separate directory levels in a path string that reflects a hierarchical file system organization.

public static char AltDirectorySeparatorChar { get; }

Property Value

char

DirectorySeparatorChar

Provides a platform-specific character used to separate directory levels in a path string that reflects a hierarchical file system organization.

public static char DirectorySeparatorChar { get; }

Property Value

char

Methods

Combine(string, string)

Combines two strings into a path.

public static string Combine(string path1, string path2)

Parameters

path1 string

First path

path2 string

Second path

Returns

string

Combine(params string[])

Combines an array of strings into a path.

public static string Combine(params string[] paths)

Parameters

paths string[]

An array of parts of the path.

Returns

string

Exceptions

ArgumentException

One of the strings in the array contains one or more of the invalid characters defined in System.IO.Path.GetInvalidPathChars().

ArgumentNullException

One of the strings in the array is null.

EnsureEndSlash(string)

Ensures that path ends with a DirectorySeparatorChar.

public static string EnsureEndSlash(string path)

Parameters

path string

Path to convert

Returns

string

EnsureForwardSlashes(string, bool)

Ensures that path contains slashes '/'

public static string EnsureForwardSlashes(string path, bool trimEnd = false)

Parameters

path string

Path to convert

trimEnd bool

If true, the end of path is trimmed for slash

Returns

string

EnsureSlashes(string, bool)

Ensures that path contains DirectorySeparatorChar.

public static string EnsureSlashes(string path, bool trimEnd = false)

Parameters

path string

Path to convert.

trimEnd bool

If true, the end of path is trimmed for DirectorySeparatorChar.

Returns

string

FindExistingDirectory(ref string, bool)

Finds the existing folder based on the given relative path

public static bool FindExistingDirectory(ref string path, bool tryMappedPath)

Parameters

path string

Relative path to folder

tryMappedPath bool

If true, the check tries also the mapped path

Returns

bool

FindExistingFile(ref string, bool)

Finds the existing file based on the given relative path

public static bool FindExistingFile(ref string path, bool tryMappedPath)

Parameters

path string

Relative path to file

tryMappedPath bool

If true, the check tries also the mapped path

Returns

bool

GetDirectoryName(string)

Gets the directory name from the given path

public static string GetDirectoryName(string path)

Parameters

path string

Input path

Returns

string

GetExtension(string)

Returns the extension of the specified path string.

public static string GetExtension(string path)

Parameters

path string

Path

Returns

string

GetFileName(string)

Gets the file name from the given path

public static string GetFileName(string path)

Parameters

path string

Input path

Returns

string

GetFileNameWithoutExtension(string)

Returns the file name of the specified path string without the extension.

public static string GetFileNameWithoutExtension(string path)

Parameters

path string

Path

Returns

string

GetFullPath(string)

Returns the absolute path for the specified path string.

public static string GetFullPath(string path)

Parameters

path string

Path

Returns

string

GetInvalidFileNameChars()

Gets an array containing the characters that are not allowed in file names.

public static char[] GetInvalidFileNameChars()

Returns

char[]

GetInvalidPathChars()

Gets an array containing the characters that are not allowed in path names.

public static char[] GetInvalidPathChars()

Returns

char[]

GetMappedPath(ref string)

Gets the mapped path for the given path. Returns true if the path was mapped

public static bool GetMappedPath(ref string path)

Parameters

path string

Path to convert

Returns

bool

HasExtension(string)

Determines whether a path includes a file name extension.

public static bool HasExtension(string path)

Parameters

path string

Path

Returns

bool

IsPathMapped(string)

Returns true, if the given path is a mapped path

public static bool IsPathMapped(string path)

Parameters

path string

Path to check

Returns

bool

IsPathRooted(string)

Gets a value indicating whether the specified path string contains absolute or relative path information.

public static bool IsPathRooted(string path)

Parameters

path string

Path

Returns

bool

RegisterMappedPath(string, string)

Maps the folder to another folder

public static void RegisterMappedPath(string path, string targetPath)

Parameters

path string

Mapped folder

targetPath string

Target folder

RegisterMappedZippedFolder(string, string)

Registers folder which is mapped to a zip file

public static void RegisterMappedZippedFolder(string path, string zipFileName)

Parameters

path string

Folder path to map to a zip file

zipFileName string

Zip file name stored in the folder containing the folder contents