GetValue()
Overrides MfPrimitive.GetValue().
OutputVar := MfFloat.GetValue(Obj)
OutputVar := MfFloat.GetValue(Obj, Default)
OutputVar := MfFloat.GetValue(Obj, Default, AllowAny)
Gets the Float number from Object or var containing float.
Obj
The Object or var containing, float, integer or hex value
Can be any type that matches IsNumber.
Returns a var containing a float.
Static Method
Throws an error if unable to convert Obj to float.
Throws MfInvalidOperationException if not called as a static method.
Throws MfArgumentException if argument Obj is can not be converted to float value.
Gets a Float number from Obj or returns Default value if Obj is unable to be converted to flaot. Default must be a value that can be converted to float or it will be ignored if Obj can not be converted to float an error will be thrown.
Obj
The Object or var containing, float, integer or hex value
Can be any type that matches IsNumber.
Default
The value to return if Obj is Cannot be converted
Can be any type that matches IsNumber or var of float.
Returns a var containing a integer or Default value if Obj is unable to be converted to float.
Static Method
If Default is not a valid float or MfFloat instance then GetValue will throw an error if Obj can not be converted to float.
If Default can not be converted to a float then this would method will yield the same results as calling MfFloat.GetValue(Obj).
Throws MfInvalidOperationException if not called as a static method.
Gets a float var from Obj or returns Default value if Obj is unable to be converted to float.Default can be something other then a number or float if AllowAny is true.
Obj
The Object or var containing, float, integer or hex value
Can be any type that matches IsNumber.
Default
The value to return if Obj is Cannot be converted
Can be any type that matches IsNumber or var of float.
AlowAny
Determines if Default can be a value other then flaot. If true Default can be any var, Object or null; Otherwise Default must be a float value.
Static Method.
If AllowAny is true then Default can be any value including var, object or null. However if AllowAny is false then this method will yield the same result as calling MfFloat.GetValue(Obj, Default).
Throws MfInvalidOperationException if not called as a static method.
Throws MfArgumentException if AllowAny is not a valid boolean.
Throws MfNotSupportedException if incorrect number of parameters are passed in.
obj := new MfInt64(MfInt64.MaxValue)
val := MfFloat.GetValue(obj)
MsgBox %val% ; displays 9223372036854775808.000000
obj := new MfByte(214)
val := MfFloat.GetValue(obj)
MsgBox %val% ; displays 214.000000
val := MfFloat.GetValue(214)
MsgBox %val% ; displays 214.000000
; when MfFloat instance is passe for obj then
; the Format of the instance is applied
obj := new MfFloat(799, , ,"0.0")
val := MfFloat.GetValue(obj)
MsgBox %val% ; displays 799
val := MfFloat.GetValue(0xE5F4)
MsgBox %val% ; displays 58868.000000
val := MfFloat.GetValue("0xE5F4")
MsgBox %val% ; displays 58868.000000
; the following will throw MfArgumentException
val := MfFloat.GetValue("abc")
MsgBox %val%
; the default set to -1 will be returned
val := MfFloat.GetValue("abc", -1)
MsgBox %val% ; displays -1.000000
VarDefault := new MfByte(MfByte.MaxValue)
val := MfFloat.GetValue("abc", VarDefault)
MsgBox %val% ; displays 255.000000
; This line will throw an error because
; default obj is not a valid float and default
; is not a valid float
val := MfFloat.GetValue("abc", "Undefined")
MsgBox %val%
; AllowAny is set to true, this will work
val := MfFloat.GetValue("abc", "Undefined", true)
MsgBox %val% ; displays Undefined
; MfNumberStyles.Instance.Number is MfEnum.EnumItem
; and MfEnum.EnumItem is of type IsNumber
val := MfFloat.GetValue(MfNumberStyles.Instance.Number)
MsgBox %val% ; displays 111.000000