Click or drag to resize

IProgressReport Interface


Represents the event based progress tracking system.

Namespace:  Ingeniux.CMS.Messaging
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.3.169
Syntax
public interface IProgressReport : IDisposable

The IProgressReport type exposes the following members.

Properties
  NameDescription
Public propertyCurrentProgress
Gets the current progress steps count
Public propertyCurrentProgressPercentage
Gets the current progress as percent times 100
Public propertyStarted
Gets whether the progress has started
Top
Methods
  NameDescription
Public methodComplete
Completes the progress, set the progression as 100%
Public methodDataProgress
Make on step on progress to save data to content store. The progress is counted differently
Public methodProgress
Make one step in the progress, with operational message
Public methodSetDataStep
Sets how many data steps to complete the progress
Public methodStart
Starts the progress, cannot be restarted
Top
Events
  NameDescription
Public eventCompleted
Event fired when progress completed
Public eventProgressed
Event fired when making one step forward in progress
Public eventProgressStarted
Event fired when progress started
Top
See Also