Option ParameterRestricted To List Property
A list of Strings that the valueo f the parameter will be validated against.
Definition
Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
If true, the parameter's value will be validated against the Strings in the OptionList.
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#
public bool RestrictedToList { get; set; }VB
Public Property RestrictedToList As Boolean
Get
SetProperty Value
BooleanIf true, the parameter's value will be validated against the Strings in the OptionList.
Implements
ICapeOptionParameterSpecRestrictedToListRemarks
If true, the parameter's value will be validated against the Strings
in the OptionList.
Exceptions
| ECapeUnknown | The error to be raised when other error(s), specified for this operation, are not suitable. |
| ECapeInvalidArgument | To be used when an invalid argument value is passed, for example, an unrecognised Compound identifier or UNDEFINED for the props argument. |