Click or drag to resize

Progress Class

This class can be used to track the progress of repetitive operations. This class implements the BindableBase class and IProgressT interface.
Inheritance Hierarchy
SystemObject
  BindableBase
    CADSharpTools.MVVM.ModelsProgress

Namespace:  CADSharpTools.MVVM.Models
Assembly:  CADSharpTools.PDM (in CADSharpTools.PDM.dll) Version: 1.4.16.0 (1.4.16)
Syntax
public class Progress : BindableBase, IProgress<int>

The Progress type exposes the following members.

Constructors
  NameDescription
Public methodProgress
Top
Properties
  NameDescription
Public propertyIsIndeterminate
Gets or sets the IsInderminate property.
Public propertyMax
Index of the last operation.
Public propertyMessage
Gets or sets a descriptive message of the current Value being processed.
Public propertyProgressColor
Gets or sets the color of the progress bar.
Public propertyValue
Current operation index.
Top
Methods
  NameDescription
Public methodCancel
Cancels the progress. Invoke this method when the user requests a cancellation.
Public methodComplete
Force the progress to complete successfully.
Public methodCompleteWithError
Completes the progress with an error.
Public methodReport
Report the progress.
Public methodReset
Reset the progress object. Invoke this method after user cancellation or to reset the progress object after completion.
Top
See Also