Class FileUtilities
Предоставляет методы работы с файлами.
Inheritance
Inherited Members
Namespace: Terrasoft.Common
Assembly: Terrasoft.Common.dll
Syntax
public static class FileUtilities
Methods
CheckIsReadOnly(String)
Проверяет, является ли заданный файл доступным только для чтения.
Declaration
public static void CheckIsReadOnly(string fileName)
Parameters
Type | Name | Description |
---|---|---|
System.String | fileName | Имя файла. |
Exceptions
Type | Condition |
---|---|
System.IO.IOException | Если заданный файл |
CombineFileName(String, String)
Формирует имя файла в формате [Путь к каталогу][Имя файла].
Declaration
[Obsolete("Метод будет удален, необходимо использовать метод System.IO.Path.Combine")]
public static string CombineFileName(string directoryPath, string fileName)
Parameters
Type | Name | Description |
---|---|---|
System.String | directoryPath | Путь к каталогу. |
System.String | fileName | Имя файла. |
Returns
Type | Description |
---|---|
System.String | Строка, представляющая путь к файлу в формате [Путь к каталогу][Имя файла]. |
Exceptions
Type | Condition |
---|---|
ArgumentNullOrEmptyException | При передаче в качестве параметра |
CompleteDirectoryName(String)
Формирует имя заданного каталога в формате [Имя каталога][Разделитель].
Declaration
public static string CompleteDirectoryName(string directoryName)
Parameters
Type | Name | Description |
---|---|---|
System.String | directoryName | Имя каталога. |
Returns
Type | Description |
---|---|
System.String | Строка, представляющая имя заданного каталога в формате [Имя каталога][Разделитель]. |
Remarks
[Разделитель] - символ, задаваемый платформой (ОС) для разделения уровней папок в строке пути.
Exceptions
Type | Condition |
---|---|
ArgumentNullOrEmptyException | При передаче в качестве
параметра |
CreateDirectory(DirectoryInfo)
Создает каталог.
Declaration
public static void CreateDirectory(DirectoryInfo directory)
Parameters
Type | Name | Description |
---|---|---|
System.IO.DirectoryInfo | directory | Экземпляр класса System.IO.DirectoryInfo, представляющий информацию о создаваемом каталоге. |
CreateDirectoryByFilePath(String)
Создает каталог по заданному пути к файлу.
Declaration
public static void CreateDirectoryByFilePath(string filePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | filePath | Путь к файлу. |
Delete(String)
Удаляет заданный файл.
Declaration
public static bool Delete(string fileName)
Parameters
Type | Name | Description |
---|---|---|
System.String | fileName | Имя файла. |
Returns
Type | Description |
---|---|
System.Boolean |
|
DeleteDirectory(String, Boolean)
Deletes the specified existing directory and, if indicated, any subdirectories and files in the directory.
Declaration
public static void DeleteDirectory(string directoryPath, bool isRecursive = false)
Parameters
Type | Name | Description |
---|---|---|
System.String | directoryPath | The name of the directory to remove. |
System.Boolean | isRecursive |
|
Exceptions
Type | Condition |
---|---|
ArgumentNullOrEmptyException | In case if |
GetCompleteParentDirectoryName(String)
Для заданного каталога возвращает полный путь родительского каталога.
Declaration
public static string GetCompleteParentDirectoryName(string directoryName)
Parameters
Type | Name | Description |
---|---|---|
System.String | directoryName | Имя каталога. |
Returns
Type | Description |
---|---|
System.String | Строка, представляющая полный путь к родительскому каталогу. |
GetFiles(String, String, IEnumerable<String>)
Возвращает имена файлов из заданной директории.
Declaration
public static IEnumerable<string> GetFiles(string directoryPath, string searchPattern, IEnumerable<string> skipPaths = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | directoryPath | Путь к директории для поиска файлов. |
System.String | searchPattern | Фильтр поиска файлов. |
System.Collections.Generic.IEnumerable<System.String> | skipPaths | Перечислитель путей, которые необходимо исключить из поиска. |
Returns
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<System.String> | Перечислитель с именами файлов. |
GetIsPathValid(String)
Declaration
public static bool GetIsPathValid(string path)
Parameters
Type | Name | Description |
---|---|---|
System.String | path |
Returns
Type | Description |
---|---|
System.Boolean |
GetMD5Hash(Byte[])
Declaration
public static string GetMD5Hash(byte[] source)
Parameters
Type | Name | Description |
---|---|---|
System.Byte[] | source |
Returns
Type | Description |
---|---|
System.String |
GetMD5Hash(String)
Declaration
public static string GetMD5Hash(string sourceFileName)
Parameters
Type | Name | Description |
---|---|---|
System.String | sourceFileName |
Returns
Type | Description |
---|---|
System.String |
GetMD5HashFromString(String)
Declaration
public static string GetMD5HashFromString(string source)
Parameters
Type | Name | Description |
---|---|---|
System.String | source |
Returns
Type | Description |
---|---|
System.String |
GetUniqueFileName(String, String)
Declaration
public static string GetUniqueFileName(string directory, string fileName)
Parameters
Type | Name | Description |
---|---|---|
System.String | directory | |
System.String | fileName |
Returns
Type | Description |
---|---|
System.String |
GetUniqueFileName(String, String, String)
Формирует уникальное имя файла для заданного каталога.
Declaration
public static string GetUniqueFileName(string directory, string fileName, string fileExtension)
Parameters
Type | Name | Description |
---|---|---|
System.String | directory | Каталог. |
System.String | fileName | Имя файла. |
System.String | fileExtension | Расширение файла. |
Returns
Type | Description |
---|---|
System.String | Строка, представляющая уникальное имя файла для заданного каталога |
IsLocked(String)
Определяет, является ли заданный файл заблокированным.
Declaration
public static bool IsLocked(string fileName)
Parameters
Type | Name | Description |
---|---|---|
System.String | fileName | Имя файла. |
Returns
Type | Description |
---|---|
System.Boolean |
|
IsReadOnly(String)
Определяет, является ли заданный файл доступным только для чтения.
Declaration
public static bool IsReadOnly(string fileName)
Parameters
Type | Name | Description |
---|---|---|
System.String | fileName | Имя файла. |
Returns
Type | Description |
---|---|
System.Boolean |
|
MakeAbsolutePath(String, String)
Формирует абсолютный путь к файлу.
Declaration
public static string MakeAbsolutePath(string baseDirectoryPath, string relativeFilePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | baseDirectoryPath | Базовый путь к каталогу. |
System.String | relativeFilePath | Относительный путь к файлу. |
Returns
Type | Description |
---|---|
System.String | Строка, представляющая абсолютный путь к файлу |
MakeRelativePath(String, String)
Формирует относительный путь к файлу.
Declaration
public static string MakeRelativePath(string baseDirectoryPath, string absoluteFilePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | baseDirectoryPath | Базовый путь к каталогу, относительно которого строится путь к файлу. |
System.String | absoluteFilePath | Абсолютный путь к файлу. |
Returns
Type | Description |
---|---|
System.String | Строка, представляющая путь к файлу |
Exceptions
Type | Condition |
---|---|
ArgumentNullOrEmptyException | Если в качестве праметров
|
Replace(String, String, Boolean)
Заменяет заданный файл другим файлом.
Declaration
public static bool Replace(string sourceFileName, string destinationFileName, bool deleteSourceFile)
Parameters
Type | Name | Description |
---|---|---|
System.String | sourceFileName | Имя заменяемого файла. |
System.String | destinationFileName | Имя заменяющего файла. |
System.Boolean | deleteSourceFile |
|
Returns
Type | Description |
---|---|
System.Boolean |
|
Replace(String, String, Boolean, Boolean)
Заменяет заданный файл другим файлом.
Declaration
public static bool Replace(string sourceFileName, string destinationFileName, bool deleteSourceFile, bool forceReplace)
Parameters
Type | Name | Description |
---|---|---|
System.String | sourceFileName | Имя заменяемого файла. |
System.String | destinationFileName | Имя заменяющего файла. |
System.Boolean | deleteSourceFile |
|
System.Boolean | forceReplace |
|
Returns
Type | Description |
---|---|
System.Boolean |
|
ResetAllAttributes(String)
Declaration
public static void ResetAllAttributes(string directoryPath)
Parameters
Type | Name | Description |
---|---|---|
System.String | directoryPath |
ResetReadOnlyAttribute(String)
Сбрасывает для заданного файла атрибут "Только для чтения".
Declaration
public static void ResetReadOnlyAttribute(string fileName)
Parameters
Type | Name | Description |
---|---|---|
System.String | fileName | Имя файла. |
SetHiddenAttribute(String)
Устанавливает для заданного файла атрибут "Скрытый".
Declaration
public static void SetHiddenAttribute(string fileName)
Parameters
Type | Name | Description |
---|---|---|
System.String | fileName | Имя файла. |
SetReadOnlyAttribute(String)
Устанавливает для заданного файла атрибут "Только для чтения".
Declaration
public static void SetReadOnlyAttribute(string fileName)
Parameters
Type | Name | Description |
---|---|---|
System.String | fileName | Имя файла. |
WriteInFile(String, String, Boolean)
Осуществляет запись в файл.
Declaration
public static void WriteInFile(string filePath, string text, bool useWriteLine = true)
Parameters
Type | Name | Description |
---|---|---|
System.String | filePath | Путь к файлу. |
System.String | text | Текст для записи. |
System.Boolean | useWriteLine |
|