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:

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

Protected Member Functions
override bool	AskInteractive (string question, bool defaultAnswer)
	Asks the user a Yes/No/Cancel question. More...
Protected Member Functions inherited from NanoByte.Common.Tasks.GuiTaskHandlerBase
	GuiTaskHandlerBase ()
	Creates a new GUI task handler. Registers a Log.Handler.
virtual void	LogHandler (LogSeverity severity, string message)
	Records Log messages in an internal log based on their LogSeverity and the current Verbosity level. More...
override bool	AskInteractive (string question, bool defaultAnswer)
	Asks the user a Yes/No/Cancel question. More...

Additional Inherited Members
Protected Attributes inherited from NanoByte.Common.Tasks.GuiTaskHandlerBase
readonly RtfBuilder	LogRtf = new()
	Stores log messages formatted in RTF for visualization.
Properties inherited from NanoByte.Common.Tasks.GuiTaskHandlerBase
override? ICredentialProvider	CredentialProvider [get]
override bool	IsInteractive [get]
Properties inherited from NanoByte.Common.Tasks.TaskHandlerBase
CancellationTokenSource	CancellationTokenSource = new() [get]
	Used to signal the CancellationToken.
CancellationToken	CancellationToken [get]
virtual ? ICredentialProvider	CredentialProvider [get]
Verbosity	Verbosity [getset]
virtual bool	IsInteractive [get]
	Indicates whether the user can provide input.
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...
ICredentialProvider?	CredentialProvider [get]
	Used to ask the user or a keyring for NetworkCredentials for specific Uris; can be null.
Verbosity	Verbosity [getset]
	The detail level of messages displayed to the user.

Detailed Description

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

This class is thread-safe.

Constructor & Destructor Documentation

DialogTaskHandler()

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

inline

Creates a new dialog task handler. Registers a Log.Handler.

Parameters

owner

The parent window for any dialogs created by the handler.

Member Function Documentation

AskInteractive()

override bool NanoByte.Common.Tasks.DialogTaskHandler.AskInteractive ( string  question, bool  defaultAnswer  )

inlineprotectedvirtual

Asks the user a Yes/No/Cancel question.

Implements NanoByte.Common.Tasks.TaskHandlerBase.

Error()

override void NanoByte.Common.Tasks.DialogTaskHandler.Error ( Exception  exception )

inlinevirtual

Displays an error message to the user.

Implements NanoByte.Common.Tasks.TaskHandlerBase.

Output()

override void NanoByte.Common.Tasks.DialogTaskHandler.Output ( string  title, string  message  )

inlinevirtual

Displays multi-line text to the user.

Implements NanoByte.Common.Tasks.TaskHandlerBase.

Output< T >()

override void NanoByte.Common.Tasks.DialogTaskHandler.Output< T > ( string  title, IEnumerable< T >  data  )

inlinevirtual

Displays tabular data to the user.

Reimplemented from NanoByte.Common.Tasks.TaskHandlerBase.

RunTask()

override void NanoByte.Common.Tasks.DialogTaskHandler.RunTask ( ITask  task )

inlinevirtual

Runs an ITask and tracks its progress. Returns once the task has been completed.

Reimplemented from NanoByte.Common.Tasks.TaskHandlerBase.

---

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

• Common.WinForms/Tasks/DialogTaskHandler.cs