Class ProgressDialog

Class that allows interacting with a native Microsoft Windows dialog that displays the progress of an operation.

Inheritance

object

ProgressDialog

Implements

IProgressDialog

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: TheXDS.MCART.Helpers

Assembly: MCART.Windows.dll

Syntax

[ExcludeFromCodeCoverage]
public sealed class ProgressDialog : IProgressDialog, IDisposable

Methods

Run(Action<IProgressDialog>)

Executes an operation that reports its status using a native Windows progress dialog.

Declaration

public static void Run(Action<IProgressDialog> progressDialog)

Parameters

Type	Name	Description
Action<IProgressDialog>	progressDialog	Reference to the operation method to execute.

Run(Func<IProgressDialog, Task>)

Executes an asynchronous operation that reports its status using a native Windows progress dialog.

Declaration

public static Task Run(Func<IProgressDialog, Task> operationCallback)

Parameters

Type	Name	Description
Func<IProgressDialog, Task>	operationCallback	Reference to the operation method to execute. The method's parameter will be an object that allows interaction with the native Windows dialog.

Returns

Type	Description
Task	A Task that can be awaited to complete the asynchronous operation.

Run(nint, ProgressDialogProperties, Action<IProgressDialog>)

Executes an operation that reports its status using a native Windows progress dialog.

Declaration

public static void Run(nint owner, ProgressDialogProperties properties, Action<IProgressDialog> operationCallback)

Parameters

Type	Name	Description
nint	owner	Reference to the owner of the new dialog.
ProgressDialogProperties	properties	Reference to the method used to initialize the new dialog.
Action<IProgressDialog>	operationCallback	Reference to the operation method to execute. The method's parameter will be an object that allows interaction with the native Windows dialog.

Run(nint, ProgressDialogProperties, Func<IProgressDialog, Task>)

Executes an asynchronous operation that reports its status using a native Windows progress dialog.

Declaration

public static Task Run(nint owner, ProgressDialogProperties properties, Func<IProgressDialog, Task> operationCallback)

Parameters

Type	Name	Description
nint	owner	Reference to the owner of the new dialog.
ProgressDialogProperties	properties	Reference to the method used to initialize the new dialog.
Func<IProgressDialog, Task>	operationCallback	Reference to the operation method to execute. The method's parameter will be an object that allows interaction with the native Windows dialog.

Returns

Type	Description
Task	A Task that can be awaited to complete the asynchronous operation.

Run(IMsWindow?, ProgressDialogProperties, Action<IProgressDialog>)

Executes an operation that reports its status using a native Windows progress dialog.

Declaration

public static void Run(IMsWindow? owner, ProgressDialogProperties properties, Action<IProgressDialog> operationCallback)

Parameters

Type	Name	Description
IMsWindow	owner	Reference to the owner of the new dialog.
ProgressDialogProperties	properties	Reference to the method used to initialize the new dialog.
Action<IProgressDialog>	operationCallback	Reference to the operation method to execute.

Run(IMsWindow?, ProgressDialogProperties, Func<IProgressDialog, Task>)

Executes an asynchronous operation that reports its status using a native Windows progress dialog.

Declaration

public static Task Run(IMsWindow? owner, ProgressDialogProperties properties, Func<IProgressDialog, Task> operationCallback)

Parameters

Type	Name	Description
IMsWindow	owner	Reference to the owner of the new dialog.
ProgressDialogProperties	properties	Reference to the method used to initialize the new dialog.
Func<IProgressDialog, Task>	operationCallback	Reference to the operation method to execute. The method's parameter will be an object that allows interaction with the native Windows dialog.

Returns

Type	Description
Task	A Task that can be awaited to complete the asynchronous operation.

Run(ProgressDialogProperties, Action<IProgressDialog>)

Executes an operation that reports its status using a native Windows progress dialog.

Declaration

public static void Run(ProgressDialogProperties properties, Action<IProgressDialog> operationCallback)

Parameters

Type	Name	Description
ProgressDialogProperties	properties	Reference to the method used to initialize the new dialog.
Action<IProgressDialog>	operationCallback	Reference to the operation method to execute.

Run(ProgressDialogProperties, Func<IProgressDialog, Task>)

Executes an asynchronous operation that reports its status using a native Windows progress dialog.

Declaration

public static Task Run(ProgressDialogProperties properties, Func<IProgressDialog, Task> operationCallback)

Parameters

Type	Name	Description
ProgressDialogProperties	properties	Reference to the method used to initialize the new dialog.
Func<IProgressDialog, Task>	operationCallback	Reference to the operation method to execute. The method's parameter will be an object that allows interaction with the native Windows dialog.

Returns

Type	Description
Task	A Task that can be awaited to complete the asynchronous operation.

Run<T>(Func<IProgressDialog, Task<T>>)

Executes an asynchronous operation that reports its status using a native Windows progress dialog.

Declaration

public static Task<T> Run<T>(Func<IProgressDialog, Task<T>> operationCallback)

Parameters

Type	Name	Description
Func<IProgressDialog, Task<T>>	operationCallback	Reference to the operation method to execute. The method's parameter will be an object that allows interaction with the native Windows dialog.

Returns

Type	Description
Task<T>	A Task<TResult> that can be awaited to complete the asynchronous operation and return a result.

Type Parameters

Name	Description
T

Run<T>(Func<IProgressDialog, T>)

Executes an operation that reports its status using a native Windows progress dialog.

Declaration

public static T Run<T>(Func<IProgressDialog, T> progressDialog)

Parameters

Type	Name	Description
Func<IProgressDialog, T>	progressDialog	Reference to the operation method to execute.

Returns

Type	Description
T	The result of the operation.

Type Parameters

Name	Description
T

Run<T>(nint, ProgressDialogProperties, Func<IProgressDialog, Task<T>>)

Executes an asynchronous operation that reports its status using a native Windows progress dialog.

Declaration

public static Task<T> Run<T>(nint owner, ProgressDialogProperties properties, Func<IProgressDialog, Task<T>> operationCallback)

Parameters

Type	Name	Description
nint	owner	Reference to the owner of the new dialog.
ProgressDialogProperties	properties	Reference to the method used to initialize the new dialog.
Func<IProgressDialog, Task<T>>	operationCallback	Reference to the operation method to execute. The method's parameter will be an object that allows interaction with the native Windows dialog.

Returns

Type	Description
Task<T>	A Task<TResult> that can be awaited to complete the asynchronous operation.

Type Parameters

Name	Description
T

Run<T>(nint, ProgressDialogProperties, Func<IProgressDialog, T>)

Executes an operation that reports its status using a native Windows progress dialog.

Declaration

public static T Run<T>(nint owner, ProgressDialogProperties properties, Func<IProgressDialog, T> operationCallback)

Parameters

Type	Name	Description
nint	owner	Reference to the owner of the new dialog.
ProgressDialogProperties	properties	Reference to the method used to initialize the new dialog.
Func<IProgressDialog, T>	operationCallback	Reference to the operation method to execute. The method's parameter will be an object that allows interaction with the native Windows dialog.

Returns

Type	Description
T	The result of the operation.

Type Parameters

Name	Description
T

Run<T>(IMsWindow?, ProgressDialogProperties, Func<IProgressDialog, Task<T>>)

Executes an asynchronous operation that reports its status using a native Windows progress dialog.

Declaration

public static Task<T> Run<T>(IMsWindow? owner, ProgressDialogProperties properties, Func<IProgressDialog, Task<T>> operationCallback)

Parameters

Type	Name	Description
IMsWindow	owner	Reference to the owner of the new dialog.
ProgressDialogProperties	properties	Reference to the method used to initialize the new dialog.
Func<IProgressDialog, Task<T>>	operationCallback	Reference to the operation method to execute. The method's parameter will be an object that allows interaction with the native Windows dialog.

Returns

Type	Description
Task<T>	A Task<TResult> that can be awaited to complete the asynchronous operation and return a result.

Type Parameters

Name	Description
T

Run<T>(IMsWindow?, ProgressDialogProperties, Func<IProgressDialog, T>)

Executes an operation that reports its status using a native Windows progress dialog.

Declaration

public static T Run<T>(IMsWindow? owner, ProgressDialogProperties properties, Func<IProgressDialog, T> operationCallback)

Parameters

Type	Name	Description
IMsWindow	owner	Reference to the owner of the new dialog.
ProgressDialogProperties	properties	Reference to the method used to initialize the new dialog.
Func<IProgressDialog, T>	operationCallback	Reference to the operation method to execute.

Returns

Type	Description
T	The result of the operation.

Type Parameters

Name	Description
T

Run<T>(ProgressDialogProperties, Func<IProgressDialog, Task<T>>)

Executes an asynchronous operation that reports its status using a native Windows progress dialog.

Declaration

public static Task<T> Run<T>(ProgressDialogProperties properties, Func<IProgressDialog, Task<T>> operationCallback)

Parameters

Type	Name	Description
ProgressDialogProperties	properties	Reference to the method used to initialize the new dialog.
Func<IProgressDialog, Task<T>>	operationCallback	Reference to the operation method to execute. The method's parameter will be an object that allows interaction with the native Windows dialog.

Returns

Type	Description
Task<T>	A Task<TResult> that can be awaited to complete the asynchronous operation and return a result.

Type Parameters

Name	Description
T

Run<T>(ProgressDialogProperties, Func<IProgressDialog, T>)

Executes an operation that reports its status using a native Windows progress dialog.

Declaration

public static T Run<T>(ProgressDialogProperties properties, Func<IProgressDialog, T> operationCallback)

Parameters

Type	Name	Description
ProgressDialogProperties	properties	Reference to the method used to initialize the new dialog.
Func<IProgressDialog, T>	operationCallback	Reference to the operation method to execute.

Returns

Type	Description
T	The result of the operation.

Type Parameters

Name	Description
T

Implements

IProgressDialog

IDisposable

Extension Methods

Objects.ShallowCopyTo(object, object, Type)

ObjectExtensions.FieldsOf<T>(object)

ObjectExtensions.GetAttribute<T>(object)

ObjectExtensions.GetAttributes<T>(object)

ObjectExtensions.HasAttrValue<TAttribute, TValue>(object, out TValue)

ObjectExtensions.HasAttribute<T>(object)

ObjectExtensions.HasAttribute<T>(object, out T?)

ObjectExtensions.HasAttributes<T>(object, out IEnumerable<T>?)

ObjectExtensions.Is(object?, object?)

ObjectExtensions.IsEither(object, IEnumerable)

ObjectExtensions.IsEither(object, params object[])

ObjectExtensions.IsNeither(object, IEnumerable)

ObjectExtensions.IsNeither(object, params object[])

ObjectExtensions.IsNot(object?, object?)

ObjectExtensions.PropertiesOf<T>(object)

ObjectExtensions.WhichAre(object, IEnumerable<object>)

ObjectExtensions.WhichAre(object, params object[])

Common.IfNotNull<T>(T?, Action<T>)

Objects.Itself<T>(T)

Objects.ShallowCopyTo<T>(T, T)

CollectionExtensions.PushInto<TItem, TCollection>(TItem, ICollection<TCollection>)

DictionaryExtensions.PushInto<TKey, TValue>(TValue, TKey, IDictionary<TKey, TValue>)