File |
Static helper methods to manipulate files, directories and ZIP archives, available in Razor scripts
Inheritance HierarchyNamespace: Seal.Helpers
Assembly: SealLibrary (in SealLibrary.dll) Version: 10.0.1.0+a44cd3a7f03c2bf3cdbd971a878c679e40bed08a
SyntaxC#
public class FileHelper
The FileHelper type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FileHelper | Initializes a new instance of the FileHelper class |
Properties| Name | Description | |
|---|---|---|
  | TempApplicationDirectory | Path of the '_Seal_Report.Temp' application temporary directory (created if necessary) |
| TempPath | Path of the temporary directory (AlternateTemporaryDirectory if set, otherwise the local user temp directory) |
Methods| Name | Description | |
|---|---|---|
| AddFolderChoices | Add recursively the sub-folder paths of a directory to a list of choices (paths relative to the repository Reports folder, with a prefix) |
| AddPersonalFolderChoices | Add recursively the sub-folder paths of a directory to a list of choices (paths relative to the repository Personal folder) |
| ChangeGUID | Replace a GUID by a new one in a report file |
| CleanFilePath | Replace invalid file name and path characters in a file path by a given string |
| ConvertOSFilePath | Convert a file path to use the directory separator of the current operating system |
| CopyDirectory | Copy the files of a directory to a destination, optionally recursive, with a search pattern and a pattern of file name starts to skip |
| CreateAndGetDirectory | Create the root directory and an optional sub-folder if they do not exist, and return the resulting path |
| CreateZIP(DictionaryString, String, String, String) | Create a ZIP archive from a dictionary of file paths and their entry names, with an optional password |
| CreateZIP(String, String, String, String) | Create a ZIP archive containing a single file with a given entry name, with an optional password |
| CreateZIPFromFile | Create a ZIP archive containing a single file, with an optional password |
| CreateZIPFromFolder | Create a ZIP archive from the files of a folder matching a filter, with an optional password |
| DeleteFile | Delete a file if it exists |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| ExtractZipFile | Extract all files of a ZIP archive to a folder, with an optional password |
| FillZipDictionaryFiles | Fill a dictionary of files for CreateZIP |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| FtpCopyDirectory | Upload the files of a directory to an FTP destination, optionally recursive |
| GetDirectorySize | Returns the total size in bytes of a directory including its sub-directories |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetResultFilePrefix | Returns the prefix used for report result file names (file name plus extension without the dot) |
| GetTempUniqueFileName | Returns a unique file name in the application temporary directory for the given file name |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| GetUniqueFileName(String, String, Boolean) | Returns a unique file name in the directory of the given path, appending a number if the file exists. If lockFile is true, an empty file is created. |
| GetUniqueFileName(String, String, String, Boolean) | Returns a unique file name in a directory, appending a number if the file exists and optionally changing the extension. If lockFile is true, an empty file is created. |
| HasInvalidFileNameChars | Returns true if the file name contains invalid characters |
| IsReportFile | Returns true if the file path has the Seal report file extension |
| IsShortcutFile | Returns true if the file path has the Seal report shortcut file extension |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MoveFile | Move (or copy if the copy flag is true) a file to a destination |
| PurgeTempApplicationDirectory | Purge the application temporary directory (files older than 8 hours) and RazorEngine directories older than 120 minutes |
| PurgeTempDirectory | Delete the files older than 8 hours in a directory |
| ReadFile | Returns the content of a file as a string |
| ReportHasSchedule | Returns true if the report file contains a schedule definition |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| WriteFile | Write a string to a file, creating the directory if necessary |
Fields| Name | Description | |
|---|---|---|
 | AlternateTemporaryDirectory | If set, overrides the temporary directory returned by TempPath |
See Also