ReturnAsObject

Gets or sets the if the MfString class will return MfString instances as their return value.
Inherited from MfPrimitive

OutputVar := instance.ReturnAsObject
instance.ReturnAsObject := Value

Value

Boolean representing true or false. Can be var or instance of MfBool.

Gets

Gets if the MfString instance will return MfString instances as their return value for various functions or vars containing strings.
The default value is false

Sets

Sets if the if the MfString instance will return MfString instances as their return value for various functions or vars containing strings.
The default value is false

The set value is returned on successful value.

str := new MfString("Hello World") ; Create a new instance of the MfString Class
objB := new MfBool(True)
OutputVar := str.ReturnAsObject := objB
MsgBox %OutputVar% ; displays 1 for true

Throws

Throws MfInvalidCastException if value is not a valid boolean var or object.

Remarks

In instances of MfString class if this property is set to true then the MfString instance class will return MfString instance class for any functions that outputs a MfPrimitive, will return MfInteger instance class for any functions that outputs integers, will return MfChar instance class for any functions that outputs MfChar value etc.
If false the MfString class will return vars (non objects) containing their respective values.
When ReturnAsObject is set to true it allows for the chaining of methods.
MfString.GetValue() method will always return a string var even if ReturnAsObject is true.

Example

myStr := new MfString(" Hello World ", true) ; Set ReturnAsObject to true will allow for chaining of methods
MsgBox % myStr.Trim().ToLower().Value ; displays hello world
myStr.ReturnAsObject := false
MsgBox % myStr.Trim() ; var is returned containing Hello World