BackgroundActionPool TParam, TReturn  MembersA Sandcastle Documented Class Library

The BackgroundActionPool TParam, TReturn  type exposes the following members.
Constructors

  NameDescription
Public methodBackgroundActionPool TParam, TReturn 
Initializes a new BackgroundActionPool object
Back to Top
Methods

  NameDescription
Private methoda_OnDone
This method is called when an action is done. Then it increments the current index and runs the next, when available. If not, it will raise the OnAllDone-Event.
Public methodAdd(BackgroundAction TParam, TReturn )
Adds a background action to the to do list
Public methodAdd(BackgroundAction TParam, TReturn , String)
Adds a background action to the to do list
Public methodCancel
Performs the current action in running loop and cancels then
Public methodCreate(Func TParam, TReturn , TParam)
Returns a new BackgroundAction object containing the current generic types signature
Public methodCreate(Func TParam, TReturn , TParam, String)
Returns a new BackgroundAction object containing the current generic types signature
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodOnlineFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Private methodNext
Triggers the next action in the to do list to perform
Public methodRun
Runs the to do loop
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Back to Top
Fields

  NameDescription
Private fieldm_iActionsDone
Contains the count of done actions
Private fieldm_iCurrentIndex
Contains the current running action index
Private fieldm_lstActions
Contains the list of actions to do
Back to Top
Properties

  NameDescription
Public propertyCanceled
Indicates whether the run was canceled
Public propertyCurrentPercentage
Contains the current progress percentage
Public propertyCurrentProgressName
Contains the current tasks name (status text)
Public propertyDone
Indicates whether the Run is done
Back to Top
Events

  NameDescription
Public eventOnAllDone
Will be raised when all actions in the list are "done"
Public eventOnNextProgress
Will be raised when the next action in the list is called
Public eventRunCanceled
Will be raised when Cancel() was called
Back to Top
See Also