All Frameworks  Object Hierarchy  This Framework  Indexes

ArrangementRectangles (Collection)

A Collection object for ArrangementRectangle objects.
Role: Use this object to manage (create, retrieve and remove) ArrangementRectangle objects.

Method Index

AddRectangle
Creates an ArrangementRectangle and adds it to the collection.
Item
Returns the specified ArrangementRectangle item of the collection object.
Remove
Removes the specified ArrangementRectangle object from the collection.

Methods


o Func AddRectangle( iRelAxis,
iPosition,
iWidth,
iLength) As
Creates an ArrangementRectangle and adds it to the collection.
Parameters:
iRelAxis
Relative Axis to be considered.
iPosition
Position information for the Rectangle (rotation and location).
iWidth
Width of the Rectangle.
iLength
Length of the Rectangle.
Returns:
Returns the newly created ArrangementRectangle and adds it to the collection.
o Func Item( iIndex) As
Returns the specified ArrangementRectangle item of the collection object.
Parameters:
iIndex
The index or the name of the ArrangementRectangle to retrieve from this collection.
To retrieve a specific object by number, use the rank of the ArrangementRectangle 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 ArrangementRectangle by name, use name that you assigned using the
AnyObject.Name property.
Returns:
The retrieved ArrangementRectangle object.
o Sub Remove( iIndex)
Removes the specified ArrangementRectangle object from the collection.
Parameters:
iIndex
The index or the name of the ArrangementRectangle to remove from this collection.
To remove a specific object by number, use the rank of the ArrangementRectangle 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 ArrangementRectangle by name, use name that you assigned using the
AnyObject.Name property.

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