Task Class

Spotfire Automation Services 14.2 API Reference
Base task class.
Inheritance Hierarchy

SystemObject
  Spotfire.Dxp.Automation.ExtensionTask
    Spotfire.Dxp.Automation.FrameworkUnknownTask

Namespace:  Spotfire.Dxp.Automation.Extension
Assembly:  Spotfire.Dxp.Automation.Framework (in Spotfire.Dxp.Automation.Framework.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax

C#
public abstract class Task : ICloneable

The Task type exposes the following members.

Constructors

  NameDescription
Protected methodTask
Initializes a new instance of the Task class. Pass the default title and display description to the base class constructor.
Top
Properties

  NameDescription
Public propertyDescription
Gets the task description as provided by the subclass constructor. The task description is not serialized. It is only used when presenting information about the available tasks, in which case the task is registered with the task registry.
Public propertyTitle
Gets or sets the title of the task. Used in job builder dialog and for logging.
Top
Methods

  NameDescription
Public methodAsT
Convenience method used to typecast to a subclass of Task.
Protected methodCloneFieldsToCore
Override to make copies of mutable non-value-type fields (e.g. lists and other objects but not strings since they are immutable) and store in the memberwiseClone instance. The base implementation does nothing since the base class only has a string field.
Public methodStatic memberCreateFromTemplate
Creates a new Task based on the template from the task registry.
Public methodExecute
Executes the task.
Protected methodExecuteCore
Implement this method to perform the task specific logic.
Top
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference