TotalWidth

Gets or sets the value associated with TotalWidth Format of Value.

OutputVar := instance.TotalWidth
instance.TotalWidth := Value

Value

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

Gets

Gets the current state of TotalWidth as string var.

Sets

Sets the current state of TotalWidth to Value.

Remarks

TotalWidth is typically 0 to indicate that number should not have any blank or zero padding. If a higher value is used, numbers will be padded with spaces or zeros to make them that wide.
Get returns a var containing integer.
If TotalWidth is high enough to cause padding, spaces will be added on the left side; that is, each number will be right-justified. To use left-justification instead, precede TotalWidth with a minus sign. To pad with zeros instead of spaces, precede TotalWidth with a zero (e.g. 06).
See Also: Format

Throws

Throws MfFormatException if Value is bad format.
Throws MfNotSupportedException on set if Readonly is true.

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'