Skip to content

Methods for cCollection

View method list in hierarchical order.

Name Type Description Defining Class
ChildByIndex Function Can be used to iterate the direct children of an object ChildByIndex is a function that can be used to iterate the direct children of an object. cObject
ClassSuperClass Function Returns the superclass of the passed class This returns the superclass of the passed class. cObject
CountOfObjects Function Returns the number of objects that are currently in the collection CountOfObjects returns the number of objects that are currently in the collection. cCollection
Create Function Creates an object based on the passed Class Id The Create function is used to dynamically create objects. cObject
CreateNamed Function Creates an object based on the passed Class Id and assigns it a name Name based on a passed name Creates an object based on the passed Class Id and assigns it a name Name based on a passed name. cObject
Delete_Data Procedure Deletes all data from the Array object Delete_Data deletes all data from the Array object. Array
Delete_Item Procedure Removes the specified item from the Array and compacts the remaining elements Delete_Item removes the specified item from the Array and compacts the remaining elements. Array
Destroy Procedure Destroys the object that receives the message and any child objects of that object The Destroy message destroys the object that receives the message. cObject
DoAppendObject Procedure Appends an object-handle, ho, to the end of the collection DoAppendObject appends an object-handle, ho, to the end of the collection. cCollection
DoInsertObject Procedure Inserts an object-handle, ho, into the collection before the hoBefore object-handle DoInsertObject inserts an object-handle, ho, into the collection before the hoBefore object-handle. cCollection
DoRemoveObject Procedure Removes the object-handle, ho, from the collection DoRemoveObject removes the object-handle, ho, from the collection. cCollection
Exit_Application Procedure Starts the process of closing an application The Exit_Application message is used to close the program. cObject
IndexFromObject Function Returns the index for the object-handle, ho, in the collection IndexFromObject returns the index for the object-handle, ho, in the collection. cCollection
IsClassOfClass Function Determines whether the target class is part of the searched class's hierarchy cObject
IsObjectIn Function Used to determine if object handle exists in the collection The IsObjectIn function is used to determine if object handle exists in the collection. cCollection
IsObjectOfClass Function Determines whether the passed class is part of the object's class hierarchy This returns True if the passed class is part of the object's class hierarchy. cObject
ObjectClass Function Returns the integer class ID assigned to the class this object is based on Returns the integer class ID assigned to the class this object is based on. cObject
ObjectFromIndex Function Returns the object-handle at index, iIndex, in the collection ObjectFromIndex returns the object-handle at index, iIndex, in the collection. cCollection
Request_Destroy_Object Procedure Use the Destroy method instead This method is used to destroy an object and all of its children. cObject
Sort_Items Procedure Sorts the items in an array in ascending or descending order Sort_items sorts the in an array in ascending or descending order. Array