NanoByte.Common  2.6.1
NanoByte.Common.Tasks.DialogTaskHandler Class Reference

Uses simple WinForms dialog boxes to inform the user about the progress of tasks. More...

Inheritance diagram for NanoByte.Common.Tasks.DialogTaskHandler:
NanoByte.Common.Tasks.GuiTaskHandlerBase NanoByte.Common.Tasks.TaskHandlerBase NanoByte.Common.MarshalNoTimeout NanoByte.Common.Tasks.ITaskHandler

Public Member Functions

 DialogTaskHandler (Control owner)
 Creates a new task handler. More...
 
override void RunTask (ITask task)
 Runs an ITask and tracks its progress. Returns once the task has been completed. The task may be executed on a different thread.
 
override bool Ask (string question, bool? defaultAnswer=null, string? alternateMessage=null)
 Asks the user a Yes/No/Cancel question.
 
override void Output (string title, string message)
 Displays multi-line text to the user.
 
override void Output< T > (string title, IEnumerable< T > data)
 Displays tabular data to the user.
 
override void Error (Exception exception)
 Displays an error message to the user.
 
- Public Member Functions inherited from NanoByte.Common.Tasks.GuiTaskHandlerBase
override bool Ask (string question, bool? defaultAnswer=null, string? alternateMessage=null)
 Asks the user a Yes/No/Cancel question.
 
override void Output (string title, string message)
 Displays multi-line text to the user.
 
override void Output< T > (string title, IEnumerable< T > data)
 Displays tabular data to the user.
 
override void Output< T > (string title, NamedCollection< T > data)
 Displays tree-like data to the user.
 
override void Error (Exception exception)
 Displays an error message to the user.
 
- Public Member Functions inherited from NanoByte.Common.Tasks.TaskHandlerBase
virtual void Dispose ()
 
- Public Member Functions inherited from NanoByte.Common.MarshalNoTimeout
override? object InitializeLifetimeService ()
 

Additional Inherited Members

- Protected Member Functions inherited from NanoByte.Common.Tasks.GuiTaskHandlerBase
override void LogHandler (LogSeverity severity, string message)
 Records Log messages in an internal log based on their LogSeverity and the current Verbosity level. More...
 
- Protected Member Functions inherited from NanoByte.Common.Tasks.TaskHandlerBase
 TaskHandlerBase ()
 Starts handling log events. More...
 
- Protected Attributes inherited from NanoByte.Common.Tasks.GuiTaskHandlerBase
readonly RtfBuilder LogRtf = new()
 Stores log messages formatted in RTF for visualization. More...
 
- Protected Attributes inherited from NanoByte.Common.Tasks.TaskHandlerBase
readonly CancellationTokenSource CancellationTokenSource = new()
 Used to signal the CancellationToken. More...
 
- Properties inherited from NanoByte.Common.Tasks.GuiTaskHandlerBase
override? ICredentialProvider CredentialProvider [get]
 
- Properties inherited from NanoByte.Common.Tasks.TaskHandlerBase
CancellationToken CancellationToken [get]
 
abstract ? ICredentialProvider CredentialProvider [get]
 
Verbosity Verbosity [get, set]
 
- Properties inherited from NanoByte.Common.Tasks.ITaskHandler
CancellationToken CancellationToken [get]
 Used to signal when the user wishes to cancel the entire current process (and any ITasks it includes). More...
 
ICredentialProviderCredentialProvider [get]
 Used to ask the user or a keyring for NetworkCredentials for specific Uris; can be null. More...
 
Verbosity Verbosity [get, set]
 The detail level of messages displayed to the user. More...
 

Detailed Description

Uses simple WinForms dialog boxes to inform the user about the progress of tasks.

Constructor & Destructor Documentation

◆ DialogTaskHandler()

NanoByte.Common.Tasks.DialogTaskHandler.DialogTaskHandler ( Control  owner)
inline

Creates a new task handler.

Parameters
ownerThe parent window for any dialogs created by the handler.

The documentation for this class was generated from the following file: