BooleanParameter Class

Boolean-Valued parameter for use in the CAPE-OPEN parameter collection.

Definition

Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)

[SerializableAttribute]
[ComVisibleAttribute(true)]
[GuidAttribute("8B8BC504-EEB5-4a13-B016-9614543E4536")]
[ClassInterfaceAttribute(ClassInterfaceType.None)]
public class BooleanParameter : CapeParameter, 
	ICapeParameter, ICapeParameterSpec, ICapeBooleanParameterSpec, ICloneable, INotifyPropertyChanged

VBRequest Example

<SerializableAttribute>
<ComVisibleAttribute(true)>
<GuidAttribute("8B8BC504-EEB5-4a13-B016-9614543E4536")>
<ClassInterfaceAttribute(ClassInterfaceType.None)>
Public Class BooleanParameter
	Inherits CapeParameter
	Implements ICapeParameter, ICapeParameterSpec, ICapeBooleanParameterSpec, ICloneable, 
	INotifyPropertyChanged

Inheritance: Object CapeIdentification CapeParameter BooleanParameter

Implements: ICapeBooleanParameterSpec, ICapeParameter, ICapeParameterSpec, INotifyPropertyChanged, ICloneable

Remarks

Boolean-Valued parameter for use in the CAPE-OPEN parameter collection.

Constructors

BooleanParameter(String, Boolean, CapeParamMode)	Constructor for the boolean-valued parameter
BooleanParameter(String, String, Boolean, 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)
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 for this 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)
OnParameterReset	Occurs when the user resets a parameter. (Inherited from CapeParameter)
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 specification of the parameter. (Overrides CapeParameterValidate(String))
Validate(Boolean, String)	Validates the value sent against the specification of the parameter.

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)
ParameterReset	Occurs when the user changes of the parameter value is reset to the default value. (Inherited from CapeParameter)
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

m_DefaultValue
m_ValStatus	The flag to indicate parameter validation's status. (Inherited from CapeParameter)
m_value
ParameterDefaultValueChanged

Extension Methods

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

Explicit Interface Implementations

ICloneableClone

Creates a copy of the parameter.