All Frameworks  Object Hierarchy  This Framework  Indexes

ArrangementProduct (Object)

Use this object as a factory for Arrangement collection objects.
Role: Use this interface to get access to the Arrangement collections (Areas, Rectangles, ItemReservations, Runs, Pathways, Boundaries) aggregated a given Product.

Property Index

ArrangementAreas
Returns the collection of ArrangementAreas under the current ArrangementProduct.
ArrangementBoundaries
Returns the collection of ArrangementBoundaries under the current ArrangementProduct.
ArrangementItemReservations
Returns the collection of ArrangementItemReservations under the current ArrangementProduct.
ArrangementPathways
Returns the collection of ArrangementPathways under the current ArrangementProduct.
ArrangementRectangles
Returns the collection of ArrangementRectangles under the current ArrangementProduct.
ArrangementRuns
Returns the collection of ArrangementRuns under the current ArrangementProduct.
Type
Returns the Type of the ArrangementProduct in the form of a String.

Method Index

GetTechnologicalObject
Returns the product's applicative data which type is the given parameter.
SetArrangementNomenclature
Sets the nomenclature of the ArrangementProduct.
SetAutoName
Causes the name of the ArrangementProduct automatically.

Properties


o Property ArrangementAreas() As (Read Only)
Returns the collection of ArrangementAreas under the current ArrangementProduct.
Example:
This example retrieves the ArrangementAreas collection, oArrAreas , for the objArrProd1 ArrangementProduct object. 
 Dim oArrAreas As ArrangementAreas
 Set oArrAreas = objArrProd1.Areas
o Property ArrangementBoundaries() As (Read Only)
Returns the collection of ArrangementBoundaries under the current ArrangementProduct.
Example:
This example retrieves the ArrangementBoundaries collection, oArrBoundaries , for the objArrProd1 ArrangementProduct object. 
 Dim oArrBoundaries As ArrangementBoundaries
 Set oArrBoundaries = objArrProd1.oArrObjType
o Property ArrangementItemReservations() As (Read Only)
Returns the collection of ArrangementItemReservations under the current ArrangementProduct.
Example:
This example retrieves the ArrangementItemReservations collection, oArrItemReservations , for the objArrProd1 ArrangementProduct object. 
 Dim oArrItemReservations As ArrangementItemReservations
 Set oArrItemReservations = objArrProd1.ItemReservations
o Property ArrangementPathways() As (Read Only)
Returns the collection of ArrangementPathways under the current ArrangementProduct.
Example:
This example retrieves the ArrangementPathways collection, oArrPathways , for the objArrProd1 ArrangementProduct object. 
 Dim oArrPathways As ArrangementPathways
 Set oArrPathways = objArrProd1.Pathways
o Property ArrangementRectangles() As (Read Only)
Returns the collection of ArrangementRectangles under the current ArrangementProduct.
Example:
This example retrieves the ArrangementRectangles collection, oArrRectangles , for the objArrProd1 ArrangementProduct object. 
 Dim oArrRectangles As ArrangementRectangles
 Set oArrRectangles = objArrProd1.Rectangles
o Property ArrangementRuns() As (Read Only)
Returns the collection of ArrangementRuns under the current ArrangementProduct.
Example:
This example retrieves the ArrangementRuns collection, oArrRuns , for the objArrProd1 ArrangementProduct object. 
 Dim oArrRuns As ArrangementRuns
 Set oArrRuns = objArrProd1.Runs
o Property Type() As (Read Only)
Returns the Type of the ArrangementProduct in the form of a String.
Example:
This example retrieves the type information as a string for the objArrProd1 ArrangementProduct object. 
 Dim oArrObjType  As String
 oArrObjType  = objArrProd1.Type

Methods


o Func GetTechnologicalObject( iApplicationType) As
Returns the product's applicative data which type is the given parameter.
Parameters:
iApplicationType
The type of applicative data searched.
oApplicativeObj
The matched applicative object.
Example:
This example retrieves the desired applicative object from the objArrProd1 object. 
 Dim objProd   As Product
 objProd  = objArrProd1.GetTechnologicalObject("Product")
o Sub SetArrangementNomenclature( iNomenclature)
Sets the nomenclature of the ArrangementProduct.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
Example:
This example sets the ArrangementNomenclature for objArrProd1 ArrangementProduct object. 
 objArrProd1.SetArrangementNomenclature = "Building"
o Sub SetAutoName()
Causes the name of the ArrangementProduct automatically.
Returns:
An HRESULT value.
Legal values:
S_OK
operation is successful
E_FAIL
operation failed
Example:
This example shows how the automatic naming of the objArrProd1 ArrangementProduct object can be done. 
 objArrProd1.SetAutoName

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