Skip to main content

GPTParameter Properties

An object defining properties for the GPTParameter class.

Caption​

Defines the display name or description for the parameter.

Type: string


ValueType​

Defines the primary type of the parameter value.

Type: ParameterValueType
Accepted Values:

NameValue
Unknown0
String1
Boolean2
Integer3
Float4
Null5
DateTime6
Guid7
Time8
Object9
Array10
Property11
DateTimeOffset12
Byte13
Double14
Decimal15
Date16
Event17
Variable18

IsActive​

Indicates whether the parameter is active.

Type: bool


IsRequired​

Indicates whether the parameter is mandatory.

Type: bool


Children​

Defines the child parameters of this parameter, allowing for hierarchical structures.

Type: List<GPTParameter>


Key​

Specifies the unique identifier for the parameter.

Type: string


IsPrivate​

Specifies whether the parameter is private and not visible to users.

Type: bool


Value​

Holds the actual value of the parameter.

Type: object


SubType​

(Optional) Specifies a more detailed type for the parameter value.

Type: ParameterValueType
Accepted Values:

NameValue
Unknown0
String1
Boolean2
Integer3
Float4
Null5
DateTime6
Guid7
Time8
Object9
Array10
Property11
DateTimeOffset12
Byte13
Double14
Decimal15
Date16
Event17
Variable18

IsChanged​

Indicates whether any changes have been made to the workflow object in the code, showing if it has unsaved modifications.

Type: bool