ProgressHandle Class

Spotfire 14.3 API Reference
Represents a handle to a progress, ProgressService.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Framework.ApplicationModelProgressHandle

Namespace:  Spotfire.Dxp.Framework.ApplicationModel
Assembly:  Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax

C#
public sealed class ProgressHandle

The ProgressHandle type exposes the following members.

Properties

  NameDescription
Public propertyDescription
Gets the description of this ProgressHandle. The description of a Progress is a user-friendly description, which is represented in the user interface associated with the operation progress (e.g. a progress dialog).
Public propertyIsCanceled
Gets a value indicating whether cancellation has been requested for this instance or not.
Public propertyTitle
Gets the title of this ProgressHandle. The title of a Progress is a user-friendly description, which is represented in the user interface associated with the operation progress (e.g. a progress dialog).
Top
Methods

  NameDescription
Public methodCancel
Flag the progress for cancellation. Note that the progress operation might not be canceled immediately.
Public methodEquals
Determines whether the specified object is equal to the current object.
(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.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference