Workflow Engine .NET

Assembly: OptimaJet.Workflow.Core

Class CodeActionParameterDefinition

OptimaJet.Workflow.Core.Model.CodeActionParameterDefinition

Represents a parameter for code action

Namespace: OptimaJet.Workflow.Core.Model

public class CodeActionParameterDefinition

Inheritance

  • System.Object

Constructors

public CodeActionParameterDefinition() #

Properties

Name
Type
Title #
String
Title of the parameter
Name #
String
Name of the parameter
Type #
ParameterType
Type of the parameter ParameterType
IsRequired #
Boolean
If false specifies that the parameter is optional
DropdownValues #
List<DropdownValue>
A list of DropdownValue for a ParameterType.Dropdown parameter
DefaultValue #
String
A default value of the parameter
Comment #
String
Comment of the parameter
CustomName #
String
Name of the custom implementation to bind. This field is only used for ParameterType.Custom type

Methods

public CodeActionParameterDefinition Clone() #
Creates a copy of the parameter definition

Returns

Type
Description
CodeActionParameterDefinition
A copy of parameter definition
public static CodeActionParameterDefinition CreateTextParameter(string name, string title = null, bool isRequired = false, string defaultValue = "", string comment = "") #

Parameters

Name
Type
Description
name
String
title
String
isRequired
Boolean
defaultValue
String
comment
String

Returns

Type
Description
CodeActionParameterDefinition
public static CodeActionParameterDefinition CreateNumberParameter(string name, string title = null, bool isRequired = false, string defaultValue = "", string comment = "") #

Parameters

Name
Type
Description
name
String
title
String
isRequired
Boolean
defaultValue
String
comment
String

Returns

Type
Description
CodeActionParameterDefinition
public static CodeActionParameterDefinition CreateCheckboxParameter(string name, string title = null, bool isRequired = false, string defaultValue = "", string comment = "") #

Parameters

Name
Type
Description
name
String
title
String
isRequired
Boolean
defaultValue
String
comment
String

Returns

Type
Description
CodeActionParameterDefinition
public static CodeActionParameterDefinition CreateDropdownParameter(string name, Dictionary<string, string> values, string title = null, bool isRequired = false, string defaultValue = "", string comment = "") #

Parameters

Name
Type
Description
name
String
values
Dictionary<String>
title
String
isRequired
Boolean
defaultValue
String
comment
String

Returns

Type
Description
CodeActionParameterDefinition
public static CodeActionParameterDefinition CreateMultiSelectParameter(string name, Dictionary<string, string> values, string title = null, bool isRequired = false, List<string> defaultValue = null, string comment = "") #

Parameters

Name
Type
Description
name
String
values
Dictionary<String>
title
String
isRequired
Boolean
defaultValue
List<String>
comment
String

Returns

Type
Description
CodeActionParameterDefinition
public static CodeActionParameterDefinition CreateDateTimeParameter(string name, string title = null, bool isRequired = false, string defaultValue = "", string comment = "") #

Parameters

Name
Type
Description
name
String
title
String
isRequired
Boolean
defaultValue
String
comment
String

Returns

Type
Description
CodeActionParameterDefinition
public static CodeActionParameterDefinition CreateDateParameter(string name, string title = null, bool isRequired = false, string defaultValue = "", string comment = "") #

Parameters

Name
Type
Description
name
String
title
String
isRequired
Boolean
defaultValue
String
comment
String

Returns

Type
Description
CodeActionParameterDefinition
public static CodeActionParameterDefinition CreateTimeParameter(string name, string title = null, bool isRequired = false, string defaultValue = "", string comment = "") #

Parameters

Name
Type
Description
name
String
title
String
isRequired
Boolean
defaultValue
String
comment
String

Returns

Type
Description
CodeActionParameterDefinition
public static CodeActionParameterDefinition CreateJsonParameter(string name, string title = null, bool isRequired = false, string defaultValue = "", string comment = "") #

Parameters

Name
Type
Description
name
String
title
String
isRequired
Boolean
defaultValue
String
comment
String

Returns

Type
Description
CodeActionParameterDefinition
public static CodeActionParameterDefinition CreateTextAreaParameter(string name, string title = null, bool isRequired = false, string defaultValue = "", string comment = "") #

Parameters

Name
Type
Description
name
String
title
String
isRequired
Boolean
defaultValue
String
comment
String

Returns

Type
Description
CodeActionParameterDefinition