OptionParameter(String, String, String, String, String, Boolean, CapeParamMode) Constructor

Constructor for the boolean-valued parameter

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
public OptionParameter(
	string name,
	string description,
	string value,
	string defaultValue,
	string[] options,
	bool restricted,
	CapeParamMode mode
)

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  String
Sets the inital value of the parameter.
defaultValue  String
Sets the default value of the parameter.
options  String
String array used as the list acceptable options.
restricted  Boolean
Sets whether the parameter value is restricted to values in the option list.
mode  CapeParamMode
Sets the CapeParamMode mode of the parameter.

Remarks

This constructor sets the ICapeIdentification.ComponentName and ICapeIdentification.ComponentDescription of the parameter. The parameter's value and default value are set to the value. Additionally, the parameters CapeParameterMode is set.

See Also