ParamInputInfo Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
← Older edit
John Leavitt (talk | contribs)
5,580 edits
No edit summary
Kate Racaza (talk | contribs)
6,536 edits
No edit summary
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:APIClass|Global_Model|Global Model}}
{{Template:API}}{{Template:APIBreadcrumb}}


Class used for parameter input.


== Constructors==
Represents the value of a parameter.
*'''[[New ParamInputInfo]]'''{{APIComment|Create a new parameter input info class.}}


== Properties ==
== Properties ==
*'''[[ParamInputInfo.Name|Name]]'''{{APIComment|Sets or returns the parameter name.}}
{| {{APITable}}
*'''[[ParamInputInfo.Min|Min]]'''{{APIComment|Sets or returns the minimum value.}}
|-
*'''[[ParamInputInfo.Max|Max]]'''{{APIComment|Sets or returns the maximum value.}}
| style="width: 200px;"|CanEqualMax||Indicates whether the entered value can equal to the maximum value. '''Boolean'''.
*'''[[ParamInputInfo.CanEqualMin|CanEqualMin]]'''{{APIComment|Sets or returns whether the value can equal the Min.}}
|-
*'''[[ParamInputInfo.CanEqualMax|CanEqualMax]]'''{{APIComment|Sets or returns whether the value can equal the Max.}}
|CanEqualMin||Indicates whether the entered value can be equal to the minimum value. '''Boolean'''.
*'''[[ParamInputInfo.Value|Value]]'''{{APIComment|Sets or returns the parameter value.}}
|-
|Max||Gets or sets the maximum parameter value that will be accepted. '''Double'''.
|-
|Min||Gets or sets the minimum parameter value that will be accepted. '''Double'''.
|-
|Name||Gets or sets the parameter name. '''String'''.
|-
|Value||Gets or sets the parameter value. '''Double'''.
|}


== Formatted Usage Example ==
{{APIComment|Creates a new ParamInputInfo.}}
        Dim MyParamInput As New ParamInputInfo("Param1", 0, 10, False, True)


{{APIComment|Change the parameter Value.}}
 
        MyParamInput.Value = 500
 
 
 
==See Also==
*[[DistrParametersInput Class]]

Latest revision as of 23:41, 6 September 2016


Member of: SynthesisAPI


Represents the value of a parameter.

Properties

Name Description
CanEqualMax Indicates whether the entered value can equal to the maximum value. Boolean.
CanEqualMin Indicates whether the entered value can be equal to the minimum value. Boolean.
Max Gets or sets the maximum parameter value that will be accepted. Double.
Min Gets or sets the minimum parameter value that will be accepted. Double.
Name Gets or sets the parameter name. String.
Value Gets or sets the parameter value. Double.




See Also

Retrieved from "https://www.reliawiki.com/index.php?title=ParamInputInfo_Class&oldid=64676"