UserTask

A User Workflow Task

Declaration Syntax

public class UserTask : UserEntity, IWorkflowTask

Table 1932: Members

Property

ActiveDirectory

Obtains the active design point directory for the task.

Property

Component

Gets the underlying project schematic component associated with this task.

Property

EditIcon

Obtains the icon displayed for the Edit menu operation.

Property

InputData

Returns the input data consumed by this task. Keys indicate the data type, values are the list of corresponding objects.

Property

InternalObject

The task's internal object (typically a DataContainerReference).

Property

OutputData

Returns the output data exposed by this task. Keys indicate the data type, values are the list of corresponding objects.

Property

Parameters

Gets the parameters defined on this container.

Property

Properties

The properties defined on this task.

Property

RegisteredFiles

A collection of all registered files associated with this task.

Property

SourceTasks

The task's source tasks.

Property

TargetTasks

The downstream tasks connected to this task.

Property

TaskGroup

Obtains the task's owning task group.

Property

TaskState

Obtains the task's State.

Property

Template

Obtains the task's template.

Property

TransferData

The task's transfer data object.

Property

Type

Gets the type of the component associated with this task.

Method

Edit( params object[])

Invokes the task's Edit method, if available.

Method

ExecuteCommand(string, IDictionary<string, object>)

Invokes a Schematic method defined on the task (e.g., SendCommand, Edit, .etc,).

Method

Exit( params object[])

Invokes the task's Exit method, if available.

Method

RegisterFile(string)

Registers and associates a file with the task.

Method

Send( params object[])

Invokes the task's Send method, if available.

Method

SignalModified()

Signals that the task is modified

Method

SignalOutputsGenerated()

Signals that the task is up-to-date with all output data fully generated.

Method

UnregisterFile(DataReference)

Unregisters and disassociates a file from the task.

Method

UnregisterFile(string)

Unregisters and disassociates a file from the task.

Method

UnregisterFile(DataReference, bool)

Unregisters and disassociates a file from the task.

Method

UnregisterFile(string, bool)

Unregisters and disassociates a file from the task.