OptionParameter Class

String Parameter class that implements the ICapeParameter and ICapeOptionParameterSpec CAPE-OPEN interfaces.

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#Request Example
[SerializableAttribute]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
[GuidAttribute("8EB0F647-618C-4fcc-A16F-39A9D57EA72E")]
[ComVisibleAttribute(true)]
public class OptionParameter : CapeParameter, 
	ICapeParameter, ICapeParameterSpec, ICapeOptionParameterSpec, ICloneable, INotifyPropertyChanged
Inheritance
Object    CapeIdentification    CapeParameter    OptionParameter
Implements
ICapeOptionParameterSpec, ICapeParameter, ICapeParameterSpec, INotifyPropertyChanged, ICloneable

Remarks

This class implements ICapeParameter, ICapeParameterSpec, ICapeOptionParameterSpec, and ICapeIdentification. It returns either a string or a System.Object, which is converted to a Variant containing a BSTR by COM Interop.

Constructors

OptionParameter(String, String) Constructor for the String-valued parameter
OptionParameter(String, String, String, String, String, Boolean, CapeParamMode) Constructor for the boolean-valued parameter

Properties

ComponentDescription Gets and sets the description of the component.
(Inherited from CapeIdentification)
ComponentName Gets and sets the name of the component.
(Inherited from CapeIdentification)
DefaultValue Gets and Sets the default value of the parameter.
Mode Gets and sets the mode of the parameter.
(Inherited from CapeParameter)
OptionList Gets and Sets the list of valid values for the parameter if 'RestrictedtoList' public is true.
RestrictedToList A list of Strings that the valueo f the parameter will be validated against.
Type Gets the type of the parameter.
(Overrides CapeParameterType)
ValStatus Gets the flag to indicate parameter validation's status.
(Inherited from CapeParameter)
Value Gets and sets the value of the parameter.

Methods

NotifyPropertyChanged Notifies the collection that the value of a proparty of the parameter has been changed.
(Inherited from CapeIdentification)
OnComponentDescriptionChanged Occurs when the user changes of the description of a component.
(Inherited from CapeIdentification)
OnComponentNameChanged Occurs when the user changes of the description of a component.
(Inherited from CapeIdentification)
OnParameterDefaultValueChanged Occurs when the user changes of the default value of a parameter.
OnParameterModeChanged Occurs when the user changes of the mode of a parameter.
(Inherited from CapeParameter)
OnParameterOptionListChanged Occurs when the user changes of the option list of a parameter.
OnParameterReset Occurs when the user resets a parameter.
(Inherited from CapeParameter)
OnParameterRestrictedToListChanged Occurs when the user changes of the upper bound of a parameter.
OnParameterValidated Occurs when a parameter is validated.
(Inherited from CapeParameter)
OnParameterValueChanged Occurs when the user changes of the value of a paramter.
(Inherited from CapeParameter)
Reset Sets the value of the parameter to its default value.
(Overrides CapeParameterReset)
Validate(String) Validates the current value of the parameter against the parameter's specification.
(Overrides CapeParameterValidate(String))
Validate(String, String) Validates the value against the parameter's specification.

Events

ComponentDescriptionChanged Occurs when the user changes of the description of a component.
(Inherited from CapeIdentification)
ComponentNameChanged Occurs when the user changes of the name of a component.
(Inherited from CapeIdentification)
ParameterDefaultValueChanged Occurs when the user changes of the default value of the parameter changes.
ParameterModeChanged Occurs when the user changes of the mode of the parameter changes.
(Inherited from CapeParameter)
ParameterOptionListChanged Occurs when the user changes of the lower bound of the parameter changes.
ParameterReset Occurs when the user changes of the parameter value is reset to the default value.
(Inherited from CapeParameter)
ParameterRestrictedToListChanged Occurs when the user changes of the upper bound of the parameter changes.
ParameterValidated Occurs when the user validates the parameter.
(Inherited from CapeParameter)
ParameterValueChanged Occurs when the user changes of the value of the parameter changes.
(Inherited from CapeParameter)
PropertyChanged Notifies the collection that the value of a proparty of the parameter has been changed.
(Inherited from CapeIdentification)

Fields

Extension Methods

GetEnumNames
(Defined by General)
IsValidDouble
(Defined by General)

Explicit Interface Implementations

ICloneableClone Creates a copy of the parameter.

See Also