Click or drag to resize

HelperFunctionsProgressBar Class

The ProgressBar Class contains methods to manage a Background Worker, used to report progress of a method using a Progress Bar. There are two initialization methods: one with DoWork, ProgressChanged and RunWorkerCompleted delegates and one with only the first two which assumes a default one for the third.
Inheritance Hierarchy
SystemObject
  AHLHelperFunctionsProgressBar

Namespace:  AHL
Assembly:  AHL (in AHL.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public static class ProgressBar

The HelperFunctionsProgressBar type exposes the following members.

Methods
  NameDescription
Public methodStatic memberCancel
This method will cancel the task at hand (must be started).
Public methodStatic memberGetWorker
This method will return the Background Worker. Needed in the DoWork Delegate.
Public methodStatic memberInitializeProgressBar(ActionObject, DoWorkEventArgs, ActionObject, ProgressChangedEventArgs)
This method will initialize the BackGround Worker for the Progress Bar. Calling this method is mandatory.
Public methodStatic memberInitializeProgressBar(ActionObject, DoWorkEventArgs, ActionObject, ProgressChangedEventArgs, ActionObject, RunWorkerCompletedEventArgs)
This method will initialize the BackGround Worker for the Progress Bar. Calling this method is mandatory.
Public methodStatic memberIsTaskCanceled
This method will return the status true if the Task has been cancelled.
Public methodStatic memberIsTaskFailed
This method will return the status true if the Task has been failed.
Public methodStatic memberIsTaskSucceded
This method will return the status true if the Task has been completed successfully.
Public methodStatic memberStart
This method will start the BackGroundWorker, beginning the work.
Top
See Also

Reference