Userobj
Userobj (user-defined object).
User Object Declaration
userobj declare an empty, unregistered user object.
A simple, non-registered, user object is created by simply using the userobj command followed by the name of the user object:
userobj myuserobject
User Object Views
Although a registered user object may have user-defined views available, all user objects have the following built-in views.
display display table, graph, or spool output in the user object window.
label display or change the label view of a user object.
members display a list of the members of a user object.
User Object Procs
Although a registered user object may have user-defined procs available, all user objects have the following built-in procs.
add add a data or object member to the user object.
clear remove all members from the user object.
clearhist clear the contents of the history attribute.
copy creates a copy of the user object.
drop drop a data or object member from the user object.
extract display or copy a data member from the user object.
label display or change the label view of a user object.
olepush push updates to OLE linked objects in open applications.
setattr set the value of an object attribute.
User Object Data Members
Although user objects can have user-defined data members, the following built-in data members also exist for all user objects.
String values
@attr("arg") string containing the value of the arg attribute, where the argument is specified as a quoted string.
@description string containing the user object’s description (if available).
@detailedtype string with the object type: “USEROBJ”.
@displayname string containing the user object’s display name. If the user object has no display name set, the name is returned.
@members space delimited list of all the user-defined members currently stored inside the user object.
@name string containing the user object’s name.
@remarks string containing the user object’s remarks (if available).
@type string with the object type: “USEROBJ”.
@updatetime string representation of the time and date at which the user object was last updated.
Scalar values
@hasmember(“name”) returns a 1 or a 0 depending on whether the user object has a data member called name.