ParamInputInfo Class: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 3: Line 3:


== Constructors==
== Constructors==
*'''[[New ParamInputInfo]]'''{{APIComment|Create a new parameter input info class.}}
*ParamInputInfo {{APIComment|Creates a ParamInputInfo object.}}


== Properties ==
== Properties ==
*'''[[ParamInputInfo.Name|Name]]'''{{APIComment|Sets or returns the parameter name.}}
*Name (as ''string'') {{APIComment|Sets or gets the parameter name.}}
*'''[[ParamInputInfo.Min|Min]]'''{{APIComment|Sets or returns the minimum value.}}
*Min (as ''double'') {{APIComment|Sets or gets the minimum value.}}
*'''[[ParamInputInfo.Max|Max]]'''{{APIComment|Sets or returns the maximum value.}}
*Max (as ''double'') {{APIComment|Sets or gets the maximum value.}}
*'''[[ParamInputInfo.CanEqualMin|CanEqualMin]]'''{{APIComment|Sets or returns whether the value can equal the Min.}}
*CanEqualMin (as ''boolean'') {{APIComment|Sets or gets whether the value can equal the Min.}}
*'''[[ParamInputInfo.CanEqualMax|CanEqualMax]]'''{{APIComment|Sets or returns whether the value can equal the Max.}}
*CanEqualMax (as ''boolean'') {{APIComment|Sets or gets whether the value can equal the Max.}}
*'''[[ParamInputInfo.Value|Value]]'''{{APIComment|Sets or returns the parameter value.}}
*Value (as ''double'') {{APIComment|Sets or gets the parameter value.}}


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

Revision as of 16:42, 11 March 2014


Class used for parameter input.

Constructors

  • ParamInputInfo Creates a ParamInputInfo object.

Properties

  • Name (as string) Sets or gets the parameter name.
  • Min (as double) Sets or gets the minimum value.
  • Max (as double) Sets or gets the maximum value.
  • CanEqualMin (as boolean) Sets or gets whether the value can equal the Min.
  • CanEqualMax (as boolean) Sets or gets whether the value can equal the Max.
  • Value (as double) Sets or gets the parameter value.

Usage Example

Creates a new ParamInputInfo.

       Dim MyParamInput As New ParamInputInfo("Param1", 0, 10, False, True)

Change the parameter Value.

       MyParamInput.Value = 500