Interface IFileHandler

An interface designed to interact with files selections by the user in the local file system

Inherited Members
Namespace: LemonEdge.Client.Core.Messages
Assembly: LemonEdge.ClientCore.dll
Syntax
public interface IFileHandler : IWindow

Methods

GetOpenFilePath(string, bool, IEnumerable<(string FileFormatName, string FileExtension)>)

Returns a file for opening selected by the user

Declaration
Task<(bool FileSelected, IEnumerable<string> FilePaths)> GetOpenFilePath(string title, bool allowMultiple, IEnumerable<(string FileFormatName, string FileExtension)> fileFormats)
Parameters
Type Name Description
string title

The title name for the reason for the file opening selection
bool allowMultiple

Indicates if multiple files should be allowed to be selected
IEnumerable<(string FileFormatName, string FileExtension)> fileFormats

Indicates a valid list of file formats that can be opened
Returns
Type Description
Task<(bool DirectorySelected, IEnumerable<string> DirectoryPaths)>

A task holding a tuple indicating if a file was selected, and if so a list of the selected files

GetSaveFilePath(string, IEnumerable<(string FileFormatName, string FileExtension)>, string)

Returns a file for saving selected by the user

Declaration
Task<(bool FileSelected, string FilePath)> GetSaveFilePath(string title, IEnumerable<(string FileFormatName, string FileExtension)> fileFormats, string defaultFileName)
Parameters
Type Name Description
string title

The title name for the reason for the file saving selection
IEnumerable<(string FileFormatName, string FileExtension)> fileFormats

Indicates a valid list of file formats that can be saved to
string defaultFileName

The default file name to save to
Returns
Type Description
Task<(bool IsValid, string ValidationFailureMessage)>

A task holding a tuple indicating if a file was selected, and if so the path to that selected file

SaveFile(string, byte[])

Declaration
Task SaveFile(string filePath, byte[] data)
Parameters
Type Name Description
string filePath
byte[] data
Returns
Type Description
Task

Extension Methods