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: ClientCore.dll
Syntax
public interface IFileHandler : IWindow
Methods
GetOpenFilePath(String, Boolean, 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 |
---|---|---|
System.String | title | The title name for the reason for the file opening selection |
System.Boolean | allowMultiple | Indicates if multiple files should be allowed to be selected |
System.Collections.Generic.IEnumerable<System.ValueTuple<System.String, System.String>> | fileFormats | Indicates a valid list of file formats that can be opened |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.ValueTuple<System.Boolean, System.Collections.Generic.IEnumerable<System.String>>> | 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 |
---|---|---|
System.String | title | The title name for the reason for the file saving selection |
System.Collections.Generic.IEnumerable<System.ValueTuple<System.String, System.String>> | fileFormats | Indicates a valid list of file formats that can be saved to |
System.String | defaultFileName | The default file name to save to |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<System.ValueTuple<System.Boolean, System.String>> | A task holding a tuple indicating if a file was selected, and if so the path to that selected file |