DecimalPlaces

Gets or sets the value associated with the DecimalPlaces part of the Format

OutputVar := instance.DecimalPlaces
instance.DecimalPlaces := Value

Value

Value is a string. Can be instance of MfString or var containing string.

Gets

Gets the DecimalPlaces as string var

Sets

Sets the DecimalPlaces for the instance

Remarks

DecimalPlaces is the number of decimal places to display (rounding will occur). If blank or zero, neither a decimal portion nor a decimal point will be displayed, that is, floating point results are displayed as integers rather than a floating point number. The starting default is 6.
Get returns a var containing integer.

Throws

Throws MfNotSupportedException if Readonly is true.
Throws MfFormatException if Value is a bad format.

Related

Format

Example

f := new MfFloat(0.5) ; ReturnAsObject is false
result := f.Value
MsgBox Result:'%result%' ; Displays Result:'0.500000'

result := f.GetTrimmed() ; returns var
MsgBox Result:'%result%' ; displays '0.5'

f := new MfFloat(0.5, , , "10.5") ; ReturnAsObject and Readonly are false
result := f.Value
MsgBox Result:'%result%' ; Displays Result:'   0.50000'

result := f.GetTrimmed() ; returns var
MsgBox Result:'%result%' ; displays '0.5'

f := new MfFloat(256.030, true, , "10.5") ; ReturnAsObject is true, Readonly is False
result := f.Value
MsgBox Result:'%result%' ; Displays Result:' 256.03000'

fTrim := f.GetTrimmed() ; returns MfFloat object instance because ReturnAsObject is true
result := fTrim.Value
MsgBox Result:'%result%' ; Displays Result:'256.03'

result := fTrim.Format
MsgBox Result:'%result%' ; Displays Result:'0.2'

f := new MfFloat()
f.TotalWidth := "012"
f.DecimalPlaces := "5"
f.Value := 256.030
f.ReturnAsObject := true
result := f.Value
MsgBox Result:'%result%' ; Displays Result:'000256.03000'

fTrim := f.GetTrimmed() ; returns MfFloat object instance because ReturnAsObject is true
result := fTrim.Value
MsgBox Result:'%result%' ; Displays Result:'256.03'

result := fTrim.Format
MsgBox Result:'%result%' ; Displays Result:'0.2'

f := new MfFloat()
f.Format := "-012.5"
f.Value := 256.1
f.ReturnAsObject := true
result := f.Value
MsgBox Result:'%result%' ; Displays Result:'256.10000   '

fTrim := f.GetTrimmed() ; returns MfFloat object instance because ReturnAsObject is true
result := fTrim.Value
MsgBox Result:'%result%' ; Displays Result:'256.1'

result := fTrim.Format
MsgBox Result:'%result%' ; Displays Result:'0.1'

f := new MfFloat(256.0, true, , "10.5") ; ReturnAsObject is true, Readonly is False
result := f.Value
MsgBox Result:'%result%' ; Displays Result:' 256.00000'

fTrim := f.GetTrimmed() ; returns MfFloat object instance because ReturnAsObject is true
result := fTrim.Value
MsgBox Result:'%result%' ; a whole number is returned - Displays Result:'256'

result := fTrim.Format
MsgBox Result:'%result%' ; Displays Result:'0.0'