Assembly: OptimaJet.Workflow.Core

Class CodeActionParameterDefinition

OptimaJet.Workflow.Core.Model.CodeActionParameterDefinition

Defines a field that Workflow Designer renders in a structured parameter form for an action, condition, rule, or custom activity.

Namespace: OptimaJet.Workflow.Core.Model

public class CodeActionParameterDefinition

Constructors

public CodeActionParameterDefinition() #
Initializes a new CodeActionParameterDefinition with an empty CodeActionParameterDefinition.DropdownValues collection.

Properties

public string Title { get; set; } #
Gets or sets the label displayed for the field.
public string Name { get; set; } #
Gets or sets the name that identifies the field in the serialized parameter data.
[JsonConverter(typeof(StringEnumConverter))] [JsonProperty(DefaultValueHandling = DefaultValueHandling.Populate)] [JsonConverter(typeof(SystemStringEnumConverter<ParameterType>))] public ParameterType Type { get; set; } #
Gets or sets the ParameterType that determines how Workflow Designer renders the field.
public bool IsRequired { get; set; } #
Gets or sets a value indicating whether Workflow Designer requires a value for the field.
public List<DropdownValue> DropdownValues { get; set; } #
Gets or sets the DropdownValue options available for ParameterType.Dropdown and ParameterType.MultiSelect fields.
[JsonConverter(typeof(NewtonsoftDefaultValueJsonConverter))] [JsonConverter(typeof(SystemTextDefaultValueJsonConverter))] public string DefaultValue { get; set; } #
Gets or sets the default field value encoded in the representation expected for CodeActionParameterDefinition.Type.
public string Comment { get; set; } #
Gets or sets explanatory text displayed with the field.
public string CustomName { get; set; } #
Gets or sets the name of the custom parameter control rendered when CodeActionParameterDefinition.Type is ParameterType.Custom.

Methods

public CodeActionParameterDefinition Clone() #
Creates a copy of this definition and clones each DropdownValue in CodeActionParameterDefinition.DropdownValues.

Returns

Type
Description
CodeActionParameterDefinition
A new CodeActionParameterDefinition containing the copied values.

Exceptions

Type
Description
NullReferenceException
Thrown when CodeActionParameterDefinition.DropdownValues is null or contains a null entry.
public static CodeActionParameterDefinition CreateTextParameter(string name, string title = null, bool isRequired = false, string defaultValue = "", string comment = "") #
Creates a text parameter definition.

Parameters

Name
Type
Description
name
String
The name stored in CodeActionParameterDefinition.Name and used to identify the field in parameter data.
title
String
The label stored in CodeActionParameterDefinition.Title, or null to use name.
isRequired
Boolean
true to set CodeActionParameterDefinition.IsRequired and require a field value; otherwise, false.
defaultValue
String
The initial text stored in CodeActionParameterDefinition.DefaultValue.
comment
String
The explanatory text stored in CodeActionParameterDefinition.Comment.

Returns

Type
Description
CodeActionParameterDefinition
A new CodeActionParameterDefinition whose CodeActionParameterDefinition.Type is ParameterType.Text.
public static CodeActionParameterDefinition CreateNumberParameter(string name, string title = null, bool isRequired = false, string defaultValue = "", string comment = "") #
Creates a numeric parameter definition.

Parameters

Name
Type
Description
name
String
The name stored in CodeActionParameterDefinition.Name and used to identify the field in parameter data.
title
String
The label stored in CodeActionParameterDefinition.Title, or null to use name.
isRequired
Boolean
true to set CodeActionParameterDefinition.IsRequired and require a field value; otherwise, false.
defaultValue
String
The initial numeric value encoded as text in CodeActionParameterDefinition.DefaultValue.
comment
String
The explanatory text stored in CodeActionParameterDefinition.Comment.

Returns

Type
Description
CodeActionParameterDefinition
A new CodeActionParameterDefinition whose CodeActionParameterDefinition.Type is ParameterType.Number.
public static CodeActionParameterDefinition CreateCheckboxParameter(string name, string title = null, bool isRequired = false, string defaultValue = "", string comment = "") #
Creates a parameter definition rendered as a check box.

Parameters

Name
Type
Description
name
String
The name stored in CodeActionParameterDefinition.Name and used to identify the field in parameter data.
title
String
The label stored in CodeActionParameterDefinition.Title, or null to use name.
isRequired
Boolean
true to set CodeActionParameterDefinition.IsRequired and require a field value; otherwise, false.
defaultValue
String
The initial bool value encoded as text in CodeActionParameterDefinition.DefaultValue.
comment
String
The explanatory text stored in CodeActionParameterDefinition.Comment.

Returns

Type
Description
CodeActionParameterDefinition
A new CodeActionParameterDefinition whose CodeActionParameterDefinition.Type is ParameterType.Checkbox.
public static CodeActionParameterDefinition CreateDropdownParameter(string name, Dictionary<string, string> values, string title = null, bool isRequired = false, string defaultValue = "", string comment = "") #
Creates a single-selection parameter definition from a set of option mappings.

Parameters

Name
Type
Description
name
String
The name stored in CodeActionParameterDefinition.Name and used to identify the field in parameter data.
values
Dictionary<String, String>
The option mappings whose keys initialize DropdownValue.Name and whose values initialize DropdownValue.Value.
title
String
The label stored in CodeActionParameterDefinition.Title, or null to use name.
isRequired
Boolean
true to set CodeActionParameterDefinition.IsRequired and require a field value; otherwise, false.
defaultValue
String
The option value stored in CodeActionParameterDefinition.DefaultValue and selected initially.
comment
String
The explanatory text stored in CodeActionParameterDefinition.Comment.

Returns

Type
Description
CodeActionParameterDefinition
A new CodeActionParameterDefinition whose CodeActionParameterDefinition.Type is ParameterType.Dropdown and whose CodeActionParameterDefinition.DropdownValues are populated from values.

Exceptions

Type
Description
ArgumentNullException
Thrown when values is null.
public static CodeActionParameterDefinition CreateMultiSelectParameter(string name, Dictionary<string, string> values, string title = null, bool isRequired = false, List<string> defaultValue = null, string comment = "") #
Creates a multiple-selection parameter definition from a set of option mappings.

Parameters

Name
Type
Description
name
String
The name stored in CodeActionParameterDefinition.Name and used to identify the field in parameter data.
values
Dictionary<String, String>
The option mappings whose keys initialize DropdownValue.Name and whose values initialize DropdownValue.Value.
title
String
The label stored in CodeActionParameterDefinition.Title, or null to use name.
isRequired
Boolean
true to set CodeActionParameterDefinition.IsRequired and require a field value; otherwise, false.
defaultValue
List<String>
The option values serialized as JSON and stored in CodeActionParameterDefinition.DefaultValue. Use null or an empty list to store an empty string.
comment
String
The explanatory text stored in CodeActionParameterDefinition.Comment.

Returns

Type
Description
CodeActionParameterDefinition
A new CodeActionParameterDefinition whose CodeActionParameterDefinition.Type is ParameterType.MultiSelect and whose CodeActionParameterDefinition.DropdownValues are populated from values.

Exceptions

Type
Description
ArgumentNullException
Thrown when values is null.
public static CodeActionParameterDefinition CreateDateTimeParameter(string name, string title = null, bool isRequired = false, string defaultValue = "", string comment = "") #
Creates a date-and-time parameter definition.

Parameters

Name
Type
Description
name
String
The name stored in CodeActionParameterDefinition.Name and used to identify the field in parameter data.
title
String
The label stored in CodeActionParameterDefinition.Title, or null to use name.
isRequired
Boolean
true to set CodeActionParameterDefinition.IsRequired and require a field value; otherwise, false.
defaultValue
String
The initial date and time encoded as text in CodeActionParameterDefinition.DefaultValue.
comment
String
The explanatory text stored in CodeActionParameterDefinition.Comment.

Returns

Type
Description
CodeActionParameterDefinition
A new CodeActionParameterDefinition whose CodeActionParameterDefinition.Type is ParameterType.DateTime.
public static CodeActionParameterDefinition CreateDateParameter(string name, string title = null, bool isRequired = false, string defaultValue = "", string comment = "") #
Creates a date parameter definition.

Parameters

Name
Type
Description
name
String
The name stored in CodeActionParameterDefinition.Name and used to identify the field in parameter data.
title
String
The label stored in CodeActionParameterDefinition.Title, or null to use name.
isRequired
Boolean
true to set CodeActionParameterDefinition.IsRequired and require a field value; otherwise, false.
defaultValue
String
The initial date encoded as text in CodeActionParameterDefinition.DefaultValue.
comment
String
The explanatory text stored in CodeActionParameterDefinition.Comment.

Returns

Type
Description
CodeActionParameterDefinition
A new CodeActionParameterDefinition whose CodeActionParameterDefinition.Type is ParameterType.Date.
public static CodeActionParameterDefinition CreateTimeParameter(string name, string title = null, bool isRequired = false, string defaultValue = "", string comment = "") #
Creates a time parameter definition.

Parameters

Name
Type
Description
name
String
The name stored in CodeActionParameterDefinition.Name and used to identify the field in parameter data.
title
String
The label stored in CodeActionParameterDefinition.Title, or null to use name.
isRequired
Boolean
true to set CodeActionParameterDefinition.IsRequired and require a field value; otherwise, false.
defaultValue
String
The initial time encoded as text in CodeActionParameterDefinition.DefaultValue.
comment
String
The explanatory text stored in CodeActionParameterDefinition.Comment.

Returns

Type
Description
CodeActionParameterDefinition
A new CodeActionParameterDefinition whose CodeActionParameterDefinition.Type is ParameterType.Time.
public static CodeActionParameterDefinition CreateJsonParameter(string name, string title = null, bool isRequired = false, string defaultValue = "", string comment = "") #
Creates a JSON parameter definition.

Parameters

Name
Type
Description
name
String
The name stored in CodeActionParameterDefinition.Name and used to identify the field in parameter data.
title
String
The label stored in CodeActionParameterDefinition.Title, or null to use name.
isRequired
Boolean
true to set CodeActionParameterDefinition.IsRequired and require a field value; otherwise, false.
defaultValue
String
The initial JSON text stored in CodeActionParameterDefinition.DefaultValue.
comment
String
The explanatory text stored in CodeActionParameterDefinition.Comment.

Returns

Type
Description
CodeActionParameterDefinition
A new CodeActionParameterDefinition whose CodeActionParameterDefinition.Type is ParameterType.Json.
public static CodeActionParameterDefinition CreateTextAreaParameter(string name, string title = null, bool isRequired = false, string defaultValue = "", string comment = "") #
Creates a multiline text parameter definition.

Parameters

Name
Type
Description
name
String
The name stored in CodeActionParameterDefinition.Name and used to identify the field in parameter data.
title
String
The label stored in CodeActionParameterDefinition.Title, or null to use name.
isRequired
Boolean
true to set CodeActionParameterDefinition.IsRequired and require a field value; otherwise, false.
defaultValue
String
The initial multiline text stored in CodeActionParameterDefinition.DefaultValue.
comment
String
The explanatory text stored in CodeActionParameterDefinition.Comment.

Returns

Type
Description
CodeActionParameterDefinition
A new CodeActionParameterDefinition whose CodeActionParameterDefinition.Type is ParameterType.TextArea.