Common Properties and Methods

A number of properties and methods of objects within the Multiframe Object Model are common to many of the objects within the library. To avoid unnecessary repetition within the manual, these common properties and methods are described below.

All of the objects that are used to model a structure, including the loading, share a number of common properties and methods. These are summarized in the following tables.

Property	Type	Description
Application	Application	Read Only. Returns a reference to the parent application of the current object.
Frame	Frame	Read Only. Returns a reference to the Frame containing the current object.
Index	Long	Read Only. Returns the index of the current object in its parent collection.
Label	String	Set/Get label associated with current object
Number	Long	Same as Index.

Method	Returns	Description
Delete		Deletes the object from the frame.

The Index, Label and Number properties are specific only to objects that are contained within collections. Objects that do not form a collection do not have these properties. The Label object is sometimes replaced by a Name property in which case the Label property is a hidden property that provides an alternative means of accessing the Name property.

The Collections objects in the Multiframe Object Model also share a common property and method as listed below.

Property	Type	Desciption
Count	Long	Read Only. Returns the number of objects in the collection.

Method	Returns	Desciption
Item	Object	Returns an object from the collection.

These collections all have a method for adding a new object to the collection. However, the naming of this method and the parameters required by the method are not standard and vary depending upon the collection.

The List objects also have a number of common properties and methods that are summarised below.

Property	Type	Desciption
Count	Long	Read Only. Returns the number of objects in the list.
Unique	Boolean	Get/Set whether each object in the list is unique.

Method	Returns	Desciption
Add		Adds an object(s) to the list.
Clear		Removes all objects from the list.
Item		Returns an object from the list.
Delete		Deletes the items in the list from the frame.
Remove		Removes an object(s) from the list.

A full description of using list objects is presented in Chapter 10.