FileHelper - класс

Вспомогательные методы для взаимодействия с файлами.

Definition

Пространство имён: Tessa.Platform.IO
Сборка: Tessa (в Tessa.dll) Версия: 4.0.4
C#
public static class FileHelper
Inheritance
Object    FileHelper

Свойства

FileHtmlSanitizer Объект, используемый для обработки содержимого html-файлов перед их открытием в браузере. При этом удаляются скрипты и опасные html-конструкции для предотвращения XSS-атак.

Методы

AcquireFilePath(FileSpecialFolder, String) Получает путь к файлу в заданной специальной папке, который может использоваться для произвольных нужд. Для файла уже создаётся папка, поэтому файл можно сразу использовать. Файл рекомендуется удалить вызовом ReleaseFilePath(String, Boolean). Файл будет удалён при очередном запуске приложения спустя сутки после того, как он не использовался.
AcquireFilePath(FileSpecialFolder, String, String) Получает путь к файлу в заданной специальной папке, который может использоваться для произвольных нужд. Для файла уже создаётся папка, поэтому файл можно сразу использовать. Файл рекомендуется удалить вызовом ReleaseFilePath(String, Boolean). Файл будет удалён при очередном запуске приложения спустя сутки после того, как он не использовался.
AcquireStreamingStringBuilder В отличии от Acquire(Int32), этот метод нужен для потокового чтения потенциально больших строк (до DefaultStreamingBufferSize). Используется совместно с ReleaseStreamingStringBuilder(StringBuilder) и ToStringAndReleaseStreamingStringBuilder(StringBuilder).
AddHtmlIEBrowserCompatibilityMeta

Устанавливает тэг совместимости с последними версиями браузера IE в заголовке html-документа. Возвращает исходный текст, если тэг уже присутствует или не найден раздел для добавления тэга.

<meta http-equiv="X-UA-Compatible" content="IE=Edge" />

Рекомендуется для использования при просмотре в контроле WebBrowser.

CheckFileName Выполняет проверку на то, что имя файла задано корректно, т.е. не содержит недопустимых символов и указание пути к файлу.
CheckHasAccess Возвращает информацию по тому, возможно ли открытие файла с указанным доступом fileAccess.
CheckHasReaderAccess Выполняет проверку того, что файл доступен для чтения его содержимого, и возвращает признак того, что проверка выполнена успешно: файл можно прочитать или файл отсутствует при указанном canBeMissing.
CopyAsync(String, String, CancellationToken) Выполняет асинхронное копирование файла на диске.
CopyAsync(String, String, Boolean, CancellationToken) Выполняет асинхронное копирование файла на диске.
Create Открывает файл для записи с указанным размером буфера. Если файл не существует, то он создаётся. Существующий файл открывается с перезаписью содержимого с начала файла. Разрешает асинхронные чтение и запись для такого файла.
CreateDirectoryIfNotExists Создаёт папку, если она не существует. Возвращает признак того, что папка уже существует или была создана в результате вызова этого метода.
CreateSubFolderPath(FileSpecialFolder) Создаёт и возвращает путь к уникальной по имени папке в заданной специальной папке. Сама папка не создаётся.
CreateSubFolderPath(String) Создаёт и возвращает путь к уникальной по имени папке в заданной папке. Сама папка не создаётся.
DeleteFileSafe Удаляет файл по заданному пути. Возвращает признак того, что файл был успешно удалён или не существовал. Не выбрасывает исключений. Не удаляет папку, в которой находился файл, даже если в папке других файлов не было.
DeleteFilesByPatterns Осуществляет удаление файлов из каталога folderPath в соответствии с шаблонами searchPatterns.
DeleteOldFiles(FileSpecialFolder) Очищает папку с файлами, которые были созданы более суток назад с использованием методов API и хранятся во временной папке пользователя. Не выбрасывает исключений, если папку не удалось удалить.
DeleteOldFiles(String, TimeSpan) Очищает папку с файлами, которые были созданы не позже, чем указанное количество времени назад keepAlivePeriod. Не выбрасывает исключений, если папку не удалось удалить. Возвращает признак того, что указанная папка существует, и её использование не привело к критической ошибке.
FileExtensionsToString Преобразует список расширений файлов в строку, разделённую пробелами. Символ ведущей точки при этом удаляется.
FinalizeAsync Выполняет финализацию файлового API при завершении приложения. Используйте метод, чтобы ожидать завершения асинхронных задач в файловом API, таких как отложенное освобождение содержимого файлов. Вызов метода является необязательным, но рекомендован для таких приложений, как TessaClient и TessaAdmin.
FindFilesByPatterns В каталоге folderPath находит файлы, соответствующие шаблонам: в соответствии с шаблонами searchPatterns.
GetExtension Возвращает расширение файла с учётом того, что в имени файла могут быть некорректные символы.
GetFileName Возвращает имя файла с расширением, но без пути к файлу с учётом того, что в имени файла могут быть некорректные символы.
GetFileNameWithoutExtension Возвращает имя файла без расширения и без пути к файлу с учётом того, что в имени файла могут быть некорректные символы.
GetPath Возвращает полный путь к заданной специальной папке.
GetWindowsLockingProcesses Возвращает список процессов, блокирующих файл. Если файл не блокируется, то возвращается пустой список процессов. Метод доступен только для Windows.
Initialize Выполняет инициализацию файлового API при старте приложения. Вызов метода является необязательным, но рекомендован для таких приложений, как TessaClient и TessaAdmin.
IsLocked Возвращает признак того, что файл заблокирован, по исключению, возникшему при открытии файла.
OpenFolderAndSelectFile Открывает окно проводника в папке с заданным файлом и выбирает в нём этот файл.
OpenRead Открывает файл для чтения с указанным размером буфера. Разрешает асинхронное чтение для такого файла, если не указано обратного.
OpenWrite Открывает файл для записи с указанным размером буфера. Если файл не существует, то он создаётся. Существующий файл открывается без перезаписи с начала файла. Разрешает асинхронную запись для такого файла.
ParseFileExtensions Получает из строки со списком расширений, разделённых пробелами, массив с этими расширениями, каждое из которых начинается с ведущей точки. Возвращаемый массив не равен null.
ReleaseFilePath(String, Boolean) Удаляет временный файл по заданному пути, который был получен вызовом метода AcquireFilePath(FileSpecialFolder, String). Возвращает признак того, что файл был успешно удалён или не существовал. Не выбрасывает исключений.
ReleaseFilePath(String, Boolean, Exception) Удаляет временный файл по заданному пути, который был получен вызовом метода AcquireFilePath(FileSpecialFolder, String). Возвращает признак того, что файл был успешно удалён или не существовал. Не выбрасывает исключений.
ReleaseFolderPath Удаляет папку, доступную по заданному пути, а также все файлы и подпапки в ней. Возвращает признак того, что папка была успешно удалена или не существовала. Не выбрасывает исключений.
ReleaseStreamingStringBuilder В отличии от Release(StringBuilder), этот метод используется совместно с AcquireStreamingStringBuilder.
RemoveInvalidFileNameChars Возвращает имя файла, в котором удалены все некорректные для имени файла символы. При этом удаляются начальные и конечные пробелы.
ResolveExistentFiles Возвращает массив путей к файлам по пути, который может ссылаться на несколько файлов при помощи символов масок '*' и '?'.
SetFileAttribute Устанавливает или сбрасывает атрибут файла.
ToStringAndReleaseStreamingStringBuilder В отличии от ToStringAndRelease(StringBuilder), этот метод используется совместно с AcquireStreamingStringBuilder.

Поля

DefaultCopyBufferSize Размер буфера по умолчанию для операций копирования содержимого файлов (методы Copy, CopyAsync). Соответствует значению по умолчанию в текущей версии .NET - Stream.DefaultCopyBufferSize.
DefaultFileBufferSize Размер буфера по умолчанию для операций с файлами. Соответствует значению по умолчанию в текущей версии .NET - FileStream.DefaultBufferSize.
DefaultStreamingBufferSize Размер буфера по умолчанию для операция с потоками Stream.
DirectorySeparatorString Символ DirectorySeparatorChar для разделения пути и имени файла в операционной системе, представленный в виде строки.
InvalidCharReplacement Рекомендуемая строка для замены невалидных символов в имени файла. Используйте эту строку, когда требуется не просто удалить такие символы, а заменить их, чтобы при использовании имени файлов, состоящего целиком из невалидных символов, не было ошибок.
WindowsMaxDirectoryLength Максимальная длина пути к папке. Аналогично константе MAX_DIRECTORY_PATH.
WindowsMaxPathLength Максимальная длина пути к файлу. Аналогично константе MAX_PATH.

См. также