Indexes  Previous Next

ArrangementAreas (Collection)

A Collection object for ArrangementArea objects.
Role: Use this interface to add, retrieve and remove ArrangementArea objects from this collection.

Method Index

AddArea
Creates a ArrangementArea and adds it to the collection.
Item
Returns the specified item of the collection.
Remove
Removes the specified ArrangementArea object from the collection.

Methods


o Func AddArea(Move iRelAxis,
CATSafeArrayVariant iPosition,
double iHeight) As ArrangementArea
Creates a ArrangementArea and adds it to the collection. The Area created will be without any contour. Hence only the height of the area is specified.
Parameters:
iRelAxis
Relative Axis to be considered.
iPosition
Position information for the Area (rotation and location).
iHeight
Height of the Area.
Returns:
The newly created ArrangementArea object that is also added to the collection.
o Func Item(CATVariant iIndex) As ArrangementArea
Returns the specified item of the collection.
Parameters:
iIndex
The index or the name of the ArrangementArea to retrieve from this collection.
To retrieve a specific object by number, use the rank of the ArrangementArea in that collection.
Note that the index of the first element in the collection is 1, and the index of the last element is Count.
To retrieve a specific ArrangementArea by name, use name that you assigned using the
AnyObject.Name property.
Returns:
The retrieved ArrangementArea object.
Example:
This example retrieves ArrangementArea, objArea1, of rank 1 under the Areas collection. 
 Dim objArea1 As ArrangementArea
 Set objArea1= Areas.Item(1)
o Sub Remove(CATVariant iIndex)
Removes the specified ArrangementArea object from the collection.
Parameters:
iIndex
The index or the name of the ArrangementArea to remove from this collection.
To remove a specific object by number, use the rank of the ArrangementArea in that collection.
Note that the index of the first element in the collection is 1, and the index of the last element is Count.
To remove a specific ArrangementArea by name, use name that you assigned using the
AnyObject.Name property.
Example:
This example removes ArrangementArea of rank 1 under the Areas collection. 
 Areas.Remove(1)

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