Boolean Parameter(String, String, Boolean, Boolean, Cape Param Mode) Constructor
Constructor for the boolean-valued parameter
Definition
Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#
public BooleanParameter(
string name,
string description,
bool value,
bool defaultValue,
CapeParamMode mode
)VB
Public Sub New (
name As String,
description As String,
value As Boolean,
defaultValue As Boolean,
mode As CapeParamMode
)Parameters
- name String
- Sets as the ComponentName of the parameter's ICapeIdentification interface.
- description String
- Sets as the ComponentDescription of the parameter's ICapeIdentification interface.
- value Boolean
- Sets the inital value of the parameter.
- defaultValue Boolean
- Sets the default value of the parameter.
- mode CapeParamMode
- Sets the CapeParamMode mode of the parameter.
Remarks
This constructor sets the ComponentName and
ComponentDescription of the
parameter. The parameter's value and default value are set to the value.
Additionally, the parameters CapeParamMode is set.