'@' (User-defined) property (Common)
Description
Gets or sets a string of user-defined data, using a custom property name. The property name is defined by the developer and must be prefixed with an '@' symbol. This string can be used for any purpose, and stays with the specified object until replaced by another string.
Property Value
A string containing user defined data.
Property Traits
Development | Runtime | Indexed | Scaled | Synthetic |
---|---|---|---|---|
N/A | Get/Set | No | No | No |
Remarks
User-defined properties are a convenient way to store application-specific data against an object at runtime. There is no limit to number of user-defined properties for an object, and they exist for the lifetime of the object they are linked to.
Example
* // Read a configuration record and cache its contents against the * // current window in an "@CONFIG" property. Read CfgRec from @File_SysEnv, CfgID Then Call Set_Property_Only( @Window, "@CONFIG", CfgRec ) End ... * // At a later point when we want to retrieve the data ... CfgData = Get_Property( @Window, "@CONFIG" )
See Also
MISC propert, UDPLIST property