IAdmParameterListOfValues
The IAdmParameterListOfValues interface represents a parameter for which the user can select a value from the list of predefined values.
Inheritance: IAdmParameter
Methods
-
Method
-
Description
-
CreateValue()
-
Creates an instance of a predefined parameter value.
-
GetPredefinedValue()
-
Returns the IAdmParameterPredefinedValue interface that represents a predefined value that matches the given parameter value.
Properties
-
Property
-
Description
-
Values
-
Gets or sets an array of values available for the parameter.
-
AllowCustomValue
-
Gets or sets a value indicating whether the user is allowed to specify a parameter value that is not present in the
Valuesproperty. -
AllowEmptyValue
-
Gets or sets a value indicating whether the parameter can be empty.
Details
CreateValue()
Creates an instance of a predefined parameter value.
IAdmParameterPredefinedValue CreateValue()
GetPredefinedValue()
Returns the IAdmParameterPredefinedValue interface that represents a predefined value that matches the given parameter value.
IAdmParameterPredefinedValue GetPredefinedValue(string value)
Return value
The method returns null if the given value does not match any of the values predefined for the parameter.
Values
Gets or sets an array of values available for the parameter.
- Type:
- IAdmParameterPredefinedValue[]
- Access:
- Read/Write
Remarks
To create a predefined parameter value, use the CreateValue method.
AllowCustomValue
Gets or sets a value indicating whether the user is allowed to specify a parameter value that is not present in the Values property.
- Type:
- bool
- Access:
- Read/Write
AllowEmptyValue
Gets or sets a value indicating whether the parameter can be empty.
- Type:
- bool
- Access:
- Read/Write
Requirements
Minimum required version: 2018.1