All Frameworks  Object Hierarchy  This Framework  Indexes

SchListOfObjects (Object)

Represent a non-persistant list of schematic objects.

Property Index

Count
Returns the number of objects in the list.

Method Index

Append
Adds an object to the end of the list.
Item
Returns an object from its index in the list.
RemoveByIndex
Remove an object from the list by specifying its position in the list.

Properties


o Property Count() As (Read Only)
Returns the number of objects in the list.
Example:
This example retrieves in NumberOfObjects the number of objects currently gathered in MyList. 
 NumberOfObjects = MyList.Count

Methods


o Sub Append( iObject)
Adds an object to the end of the list.
Parameters:
iObject
The object to be added to the list.
Example:
The following example appends an object to the list. 
 Dim MyObject As AnyObject
 Dim MyList As SchListOfObjects
 MyList.Append(MyObject)
o Func Item( iIndex,
iInterfaceName) As
Returns an object from its index in the list.
Parameters:
iIndex
The index of the first object in the collection is 1, and the index of the last object is Count.
iInterfaceName
The interface name of oObj.
Returns:
the retrieved object.
Example:
The following example returns in the third object in the list. 
 Dim MyObject As AnyObject
 Dim MyList As SchListOfObjects
 Set MyObject = SchListOfObjects.Item(2,"CATIASchComponent")
o Sub RemoveByIndex( iIndex)
Remove an object from the list by specifying its position in the list.
Parameters:
iIndex
The position of the object to be removed in the list.
Example:
The following example removes the second entry in the list. Please note that the list index starts with 1. 
 Dim MyList As SchListOfObjects
 MyList.Remove(1)

Copyright © 2003, Dassault Systèmes. All rights reserved.