REMOVEPROPERTY()

From Recital Documentation Wiki
Jump to: navigation, search

Purpose

Function to remove a property from an existing object


Syntax

REMOVEPROPERTY(<object-name> ,<expC>)


See Also

ACLASS(), ADDPROPERTY(), AMEMBERS(), CLASS, CLASS - Methods, CLASS - Parameters, CLASS - Properties, CLASS - Scoping, COMPOBJ(), CREATEOBJECT(), DEFINE CLASS, DISPLAY CLASSES, DODEFAULT(), FOREACH, LIST CLASSES, LOADOBJECT(), METHOD, NEWOBJECT(), OBJECT(), PRINT_HTML(), PRINT_JSON(), PRINT_R(), PRINT_XML(), REQUIRE_ONCE(), SAVEOBJECT(), SQL SELECT, WITH


Description

The REMOVEPROPERTY() function is used to remove a property from an existing object. It returns .T. (True) if the property was successfully removed and .F. (False) otherwise.


Parameter Description
<object-name> The name of the object.
<expC> The name of the property to be removed.


All classes also have an inbuilt removeproperty method. This can be used as an alternative to the REMOVEPROPERTY() function to remove properties from an object at runtime.

<object-name>.removeproperty(<expC>)


Properties can be added using the ADDPROPERTY() function or inbuilt addproperty method.


Example

define class myclass as custom
  myprop = "Hello World"
enddefine
 
myobject = createobject("myclass")
Messagebox(myobject.myprop)
addproperty(myobject, "myprop2", "goodbye")
// Or: myobject.addproperty("myprop2", "goodbye")
Messagebox(myobject.myprop2)
removeproperty(myobject, "myprop2")
// Or: myobject.removeproperty("myprop2")


Products

Recital, Recital Server