NanoByte.Common.Tasks.TaskRunDialog Class Reference

A dialog with a progress bar that runs and tracks the progress of an ITask. More...

Inheritance diagram for NanoByte.Common.Tasks.TaskRunDialog:

Public Member Functions
	TaskRunDialog (ITask task, ICredentialProvider? credentialProvider, CancellationTokenSource cancellationTokenSource)
	Creates a new task tracking dialog. More...

Protected Member Functions
override void	Dispose (bool disposing)
	Clean up any resources being used. More...

Properties
Exception?	Exception [get]
	An exception thrown by ITask.Run, if any. More...

Detailed Description

A dialog with a progress bar that runs and tracks the progress of an ITask.

Constructor & Destructor Documentation

TaskRunDialog()

NanoByte.Common.Tasks.TaskRunDialog.TaskRunDialog ( ITask  task, ICredentialProvider?  credentialProvider, CancellationTokenSource  cancellationTokenSource  )

inline

Creates a new task tracking dialog.

Parameters

task	The trackable task to execute and display.
credentialProvider	Object used to retrieve credentials for specific Uris on demand; can be null.
cancellationTokenSource	Used to signal if the user pressed the Cancel button.

Member Function Documentation

Dispose()

override void NanoByte.Common.Tasks.TaskRunDialog.Dispose ( bool  disposing )

inlineprotected

Clean up any resources being used.

Parameters

disposing

true if managed resources should be disposed; otherwise, false.

Property Documentation

Exception

Exception? NanoByte.Common.Tasks.TaskRunDialog.Exception

get

An exception thrown by ITask.Run, if any.

---

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

• Common.WinForms/Tasks/TaskRunDialog.cs
• Common.WinForms/Tasks/TaskRunDialog.Designer.cs