Class CodeActionParameterDefinition

Represents a parameter for code action

Inheritance

↳ object

    ↳ CodeActionParameterDefinition

Inherited Members

Equals(object)

Equals(object, object)

GetHashCode()

GetType()

MemberwiseClone()

ReferenceEquals(object, object)

ToString()

Namespace: OptimaJet.Workflow.Core.Model

Assembly: OptimaJet.Workflow.Core.dll

Syntax

public class CodeActionParameterDefinition

Constructors

CodeActionParameterDefinition()

Declaration

public CodeActionParameterDefinition()

Properties

Title

Title of the parameter

Declaration

public string Title { get; set; }

Property value

Type	Description
string

Name

Name of the parameter

Declaration

public string Name { get; set; }

Property value

Type	Description
string

Type

Type of the parameter ParameterType

Declaration

[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty(DefaultValueHandling = DefaultValueHandling.Populate)]
public ParameterType Type { get; set; }

Property value

Type	Description
ParameterType

IsRequired

If false specifies that the parameter is optional

Declaration

public bool IsRequired { get; set; }

Property value

Type	Description
bool

DropdownValues

A list of DropdownValue for a ParameterType.Dropdown parameter

Declaration

public List<DropdownValue> DropdownValues { get; set; }

Property value

Type	Description
List<DropdownValue>

DefaultValue

A default value of the parameter

Declaration

[JsonConverter(typeof(DefaultValueJsonConverter))]
public string DefaultValue { get; set; }

Property value

Type	Description
string

Comment

Comment of the parameter

Declaration

public string Comment { get; set; }

Property value

Type	Description
string

CustomName

Name of the custom implementation to bind. This field is only used for ParameterType.Custom type

Declaration

public string CustomName { get; set; }

Property value

Type	Description
string

Methods

Clone()

Creates a copy of the parameter definition

Declaration

public CodeActionParameterDefinition Clone()

Returns

Type	Description
CodeActionParameterDefinition	A copy of parameter definition

CreateTextParameter(string, string, bool, string, string)

Declaration

public static CodeActionParameterDefinition CreateTextParameter(string name, string title = null, bool isRequired = false, string defaultValue = "", string comment = "")

Parameters

Type	Name	Description
string	name
string	title
bool	isRequired
string	defaultValue
string	comment

Returns

Type	Description
CodeActionParameterDefinition

CreateNumberParameter(string, string, bool, string, string)

Declaration

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

Parameters

Type	Name	Description
string	name
string	title
bool	isRequired
string	defaultValue
string	comment

Returns

Type	Description
CodeActionParameterDefinition

CreateCheckboxParameter(string, string, bool, string, string)

Declaration

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

Parameters

Type	Name	Description
string	name
string	title
bool	isRequired
string	defaultValue
string	comment

Returns

Type	Description
CodeActionParameterDefinition

CreateDropdownParameter(string, Dictionary<string, string>, string, bool, string, string)

Declaration

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

Parameters

Type	Name	Description
string	name
Dictionary<string, string>	values
string	title
bool	isRequired
string	defaultValue
string	comment

Returns

Type	Description
CodeActionParameterDefinition

CreateMultiSelectParameter(string, Dictionary<string, string>, string, bool, List<string>, string)

Declaration

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

Parameters

Type	Name	Description
string	name
Dictionary<string, string>	values
string	title
bool	isRequired
List<string>	defaultValue
string	comment

Returns

Type	Description
CodeActionParameterDefinition

CreateDateTimeParameter(string, string, bool, string, string)

Declaration

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

Parameters

Type	Name	Description
string	name
string	title
bool	isRequired
string	defaultValue
string	comment

Returns

Type	Description
CodeActionParameterDefinition

CreateDateParameter(string, string, bool, string, string)

Declaration

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

Parameters

Type	Name	Description
string	name
string	title
bool	isRequired
string	defaultValue
string	comment

Returns

Type	Description
CodeActionParameterDefinition

CreateTimeParameter(string, string, bool, string, string)

Declaration

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

Parameters

Type	Name	Description
string	name
string	title
bool	isRequired
string	defaultValue
string	comment

Returns

Type	Description
CodeActionParameterDefinition

CreateJsonParameter(string, string, bool, string, string)

Declaration

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

Parameters

Type	Name	Description
string	name
string	title
bool	isRequired
string	defaultValue
string	comment

Returns

Type	Description
CodeActionParameterDefinition

CreateTextAreaParameter(string, string, bool, string, string)

Declaration

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

Parameters

Type	Name	Description
string	name
string	title
bool	isRequired
string	defaultValue
string	comment

Returns

Type	Description
CodeActionParameterDefinition

Extension Methods

• Extensions.CastAs<T>(object)
• Extensions.ExtendedEquals(object, object)
• Extensions.TryCast<T>(object, out T)