Difference between revisions of "ADDPROPERTY()"
Yvonnemilne (Talk | contribs) |
Yvonnemilne (Talk | contribs) |
||
| (11 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
| − | |||
| − | |||
==Purpose== | ==Purpose== | ||
Function to add a property to an existing object | Function to add a property to an existing object | ||
| Line 12: | Line 8: | ||
==See Also== | ==See Also== | ||
| − | [[ACLASS()]], [[AMEMBERS()]], [[CLASS]], [[COMPOBJ()]], [[CREATEOBJECT()]], [[DEFINE CLASS]], [[DODEFAULT()]], [[METHOD]], [[NEWOBJECT()]], [[REMOVEPROPERTY()]], [[ | + | [[ACLASS()]], [[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()]], [[REMOVEPROPERTY()]], [[REQUIRE_ONCE()]], [[SAVEOBJECT()]], [[SQL SELECT]], [[WITH]] |
==Description== | ==Description== | ||
| − | The | + | The ADDPROPERTY() function is used to add a property to an existing object. It returns .T. (True) if the property was successfully added and .F. (False) otherwise. |
| Line 31: | Line 27: | ||
| − | + | All classes have an inbuilt ''addproperty'' method. This can be used as an alternative to the ADDPROPERTY() function to add properties to an object at runtime. | |
| + | |||
| + | <object-name>.addproperty(<expC>,<exp>) | ||
| + | |||
| + | Note: the <exp> value is required. | ||
| + | |||
| − | + | Properties can be removed using the REMOVEPROPERTY() function or inbuilt ''removeproperty'' method. | |
| Line 39: | Line 40: | ||
<code lang="recital"> | <code lang="recital"> | ||
define class myclass as custom | define class myclass as custom | ||
| − | myprop = "Hello World" | + | myprop = "Hello World" |
enddefine | enddefine | ||
| Line 48: | Line 49: | ||
Messagebox(myobject.myprop2) | Messagebox(myobject.myprop2) | ||
removeproperty(myobject, "myprop2") | removeproperty(myobject, "myprop2") | ||
| + | // Or: myobject.removeproperty("myprop2") | ||
</code> | </code> | ||
==Products== | ==Products== | ||
| − | Recital | + | Recital Server, Recital |
[[Category:Documentation]] | [[Category:Documentation]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
| + | [[Category:Objects]] | ||
| + | [[Category:Objects Functions]] | ||
Latest revision as of 14:56, 14 December 2009
Purpose
Function to add a property to an existing object
Syntax
ADDPROPERTY(<object-name> ,<expC>[,<exp>])
See Also
ACLASS(), 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(), REMOVEPROPERTY(), REQUIRE_ONCE(), SAVEOBJECT(), SQL SELECT, WITH
Description
The ADDPROPERTY() function is used to add a property to an existing object. It returns .T. (True) if the property was successfully added and .F. (False) otherwise.
| Parameter | Description |
|---|---|
| <object-name> | The name of the object. |
| <expC> | The name of the property to be added. |
| <exp> | The value to assign to the property being added. This is optional: if omitted and the property being added already exists, the property value is unchanged, if omitted and the property is new, the value is initialized to .F. (False). |
All classes have an inbuilt addproperty method. This can be used as an alternative to the ADDPROPERTY() function to add properties to an object at runtime.
<object-name>.addproperty(<expC>,<exp>)
Note: the <exp> value is required.
Properties can be removed using the REMOVEPROPERTY() function or inbuilt removeproperty 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 Server, Recital
