Class FormBase
OptimaJet.Workflow.Core.FormBase
Defines the low-level metadata and execution contract for forms exposed to the workflow designer.
Namespace: OptimaJet.Workflow.Core
public abstract class FormBaseType Hierarchy
Constructors
Properties
public virtual bool Disabled { get; set; } #Gets or sets a value indicating whether this form is excluded from the custom activity or condition metadata exposed to the workflow designer.
public virtual string Type { get; set; } #Gets or sets the form type identifier.
public virtual string Title { get; set; } #Gets or sets the human-readable title for the form.
public virtual string Template { get; set; } #Gets or sets the form template name used by UI renderers.
public virtual List<CodeActionParameterDefinition> Parameters { get; set; } #Gets or sets the form parameter definitions.
public virtual Dictionary<string, object> DefaultValues { get; set; } #Gets or sets form-specific default values.
Methods
public abstract Task ExecutionAsync(WorkflowRuntime runtime, ProcessInstance processInstance, Dictionary<string, string> parameters, CancellationToken token) #Executes the form operation during normal workflow execution.
Parameters
Name
Type
Description
parametersDictionary<String, String>Runtime parameter values for the executed form operation, keyed by parameter name.
Returns
Type
Description
TaskA Task that represents the asynchronous execution.
public abstract Task PreExecutionAsync(WorkflowRuntime runtime, ProcessInstance processInstance, Dictionary<string, string> parameters, CancellationToken token) #Executes the form operation during pre-execution simulation.
Parameters
Name
Type
Description
parametersDictionary<String, String>Runtime parameter values for the simulated operation, keyed by parameter name.
Returns
Type
Description
TaskA Task that represents the asynchronous simulation.
Fields
public static readonly string CustomTypeAnnotationName #Gets the annotation key used to store a form custom type.
Remarks
To implement a custom workflow activity, derive from ActivityBase instead of this class. ActivityBase adds the metadata and rules required to display, configure, and save an activity node in the workflow designer. Direct inheritance from FormBase is intended only for specialized form-based extension points, such as custom condition editors, that do not represent activity nodes on the scheme canvas.