Class DialogTaskHandler

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

Inheritance
Object
TaskHandlerBase
GuiTaskHandlerBase
DialogTaskHandler
Implements
Inherited Members
Namespace: NanoByte.Common.Tasks
Assembly: NanoByte.Common.WinForms.dll
Syntax
public class DialogTaskHandler : GuiTaskHandlerBase, ITaskHandler, IDisposable
Remarks

This class is thread-safe.

Constructors

DialogTaskHandler(Control)

Creates a new dialog task handler. Registers a Handler.

Declaration
public DialogTaskHandler(Control owner)
Parameters
Type Name Description
Control owner

The parent window for any dialogs created by the handler.

Methods

AskInteractive(String, Boolean)

Asks the user a Yes/No/Cancel question.

Declaration
protected override bool AskInteractive(string question, bool defaultAnswer)
Parameters
Type Name Description
String question

The question and comprehensive information to help the user make an informed decision.
Boolean defaultAnswer

The default answer to preselect.
Returns
Type Description
Boolean

true if the user answered with 'Yes'; false if the user answered with 'No'.
Overrides
Exceptions
Type Condition
OperationCanceledException

Throw if the user answered with 'Cancel'.

Error(Exception)

Declaration
public override void Error(Exception exception)
Parameters
Type Name Description
Exception exception
Overrides

Output(String, String)

Displays multi-line text to the user.

Declaration
public override void Output(string title, string message)
Parameters
Type Name Description
String title

A title for the message.
String message

The string to display. Trailing linebreaks are appropriately handled or ignored.
Overrides
Remarks

Implementations may close the UI as a side effect. Therefore this should be your last call on the handler.

Output<T>(String, IEnumerable<T>)

Displays tabular data to the user.

Declaration
public override void Output<T>(string title, IEnumerable<T> data)
Parameters
Type Name Description
String title

A title for the data.
IEnumerable<T> data

The data to display.
Type Parameters
Name Description
T
Overrides
NanoByte.Common.Tasks.GuiTaskHandlerBase.Output<T>(System.String, System.Collections.Generic.IEnumerable<T>)
Remarks

Implementations may close the UI as a side effect. Therefore this should be your last call on the handler.

RunTask(ITask)

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

Declaration
public override void RunTask(ITask task)
Parameters
Type Name Description
ITask task

The task to be run. (Run(CancellationToken, ICredentialProvider, IProgress<TaskSnapshot>) or equivalent is called on it.)
Overrides
Exceptions
Type Condition
OperationCanceledException

The user canceled the task.
IOException

The task ended with IOError.
WebException

The task ended with WebError.

Implements

Extension Methods