Interface IProgressReporterCommon

Interface to provide progress properties to be exposed by a view model for data binding a progress reporter GUI control.

Inherited Members
Namespace: BionicCode.Utilities.Net
Assembly: BionicCode.Utilities.Net.Common.dll
Syntax
public interface IProgressReporterCommon : INotifyPropertyChanged

Properties

| Improve this Doc View Source

IsIndeterminate

Indicates that the progress reporting is indeterminate.

Declaration
bool IsIndeterminate { get; set; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

IsReportingProgress

Indicates ongoing progress reporting

Declaration
bool IsReportingProgress { get; }
Property Value
Type Description
Boolean
Remarks

Raises PropertyChanged event.

| Improve this Doc View Source

ProgressText

The progress message.

Declaration
string ProgressText { get; set; }
Property Value
Type Description
String
Remarks

Raises PropertyChanged event.

| Improve this Doc View Source

ProgressValue

The progress value.

Declaration
double ProgressValue { get; set; }
Property Value
Type Description
Double
Remarks

Raises PropertyChanged event.

Methods

| Improve this Doc View Source

CreateProgressReporterFromCurrentThread()

Creates a IProgress<T> instance that is associated with the caller's thread. The registered progress callback is the virtual OnProgress(ProgressData) member.

Declaration
IProgress<ProgressData> CreateProgressReporterFromCurrentThread()
Returns
Type Description
IProgress<ProgressData>

A IProgress<T> instance that posts progress to the thread CreateProgressReporterFromCurrentThread() was called from.
Remarks

To create a IProgress<T> instance that is associated with the application's primary dispatcher thread, for example to update proreties that bind to a DispatcherObject, call IProgressReporter.CreateProgressReporterFromUiThread.

Events

| Improve this Doc View Source

ProgressChanged

Raised when ProgressValue, ProgressText or IsIndeterminate has changed.

Declaration
event ProgressChangedEventHandler ProgressChanged
Event Type
Type Description
ProgressChangedEventHandler

Extension Methods