Progress Methods

Spotfire 14.3 API Reference

The Progress type exposes the following members.

Methods

  NameDescription
Public methodCode exampleBeginSubtask
Starts a new determinate subtask, that is, a subtask in which the extent of the operation is known, for example that it requires x steps to be performed.
Public methodCheckCancel
Checks if the current progress operation has been canceled by the user and if so, throws a ProgressCanceledException.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodCode exampleExecuteSubtask(String)
Marks the start of a new subtask.
Public methodCode exampleExecuteSubtask(String, ProgressOperation)
Starts a new continuous subtask, that is, a subtask in which the extent of the operation is either not known or not of interest.
Public methodCode exampleExecuteSubtask(String, Int64, String, ProgressOperation)
Starts a new determinate subtask, that is, a subtask in which the extent of the operation is known, for example that it requires x steps to be performed.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodTryReportProgress
Reports one unit of progress to the currently executing subtask.
Public methodTryReportProgress(Int64)
Report one or more steps of progress to the currently executing subtask.
Top
See Also

Reference