All Frameworks  Object Hierarchy  This Framework  Indexes   

FixTogether (Object)

The object that manages a sequence of products or fixTogethers.

It belongs to the FixTogether collection of a Product.

Property Index

FixTogethersCount
Returns the number of FixTogether entities in the FixTogether.
ProductsCount
Returns the number of products fixed together in the FixTogether.

Method Index

AddFixTogether
Add a fixTogether to a FixTogether.
AddProduct
Add a product to a FixTogether.
GetFixTogether
Returns a FixTogether using its index or its name in the FixTogether.
GetProduct
Returns a Product using its index or its name in the FixTogether.
RemoveFixTogether
Removes a FixTogether from the FixTogether.
RemoveProduct
Removes a Product from the FixTogether.

Properties


o Property FixTogethersCount() As (Read Only)
Returns the number of FixTogether entities in the FixTogether.
Example:
The following example retrieves in fixTogethersCount the number of FixTogethers of the myFixTogether FixTogether :
 fixTogethersCount = myFixTogether.FixTogethersCount
 
o Property ProductsCount() As (Read Only)
Returns the number of products fixed together in the FixTogether.
Example:
The following example retrieves in productsCount the number of products of the myFixTogether FixTogether :
 productsCount = myFixTogether.ProductsCount
 

Methods


o Sub AddFixTogether( iFixTogether)
Add a fixTogether to a FixTogether. The fixTogether is fixed together with the products or fixTogethers already contained in the FixTogether.
Example:
The following example adds a FixTogether fixTogether in a FixTogether myFixTogether.
 myFixTogether.AddFixTogether(fixTogether)
 
o Sub AddProduct( iProduct)
Add a product to a FixTogether. The product is fixed together with the products and fixTogethers already contained in the FixTogether.
Example:
The following example adds a Product myProduct in a FixTogether.
 myFixTogether.AddProduct(myProduct)
 
o Func GetFixTogether( iIndex) As
Returns a FixTogether using its index or its name in the FixTogether.
Parameters:
iIndex
The index or the name of the FixTogether to retrieve. As a numerics, this index is the rank of the FixTogether in the FixTogethers of the FixTogether. The index of the first FixTogether is 1, and the index of the last FixTogether is FixTogethersCount. As a string, it is the name you assigned to the FixTogether using the
AnyObject.Name property.
Returns:
The retrieved FixTogether
Example:
This example retrieves in thisFixTogether the fifth FixTogether and in thatFixTogether the FixTogether named myFixTogether in the FixTogethers of the FixTogether.
 Dim thisFixTogether As FixTogether
 Set thisFixTogether = myFixTogether.GetFixTogether(5)
 Dim thatFixTogether As FixTogether
 Set thatFixTogether = myFixTogether.GetFixTogether("myFixTogether")
 
o Func GetProduct( iIndex) As
Returns a Product using its index or its name in the FixTogether.
Parameters:
iIndex
The index or the name of the Product to retrieve. As a numerics, this index is the rank of the Product in the products of the FixTogether. The index of the first Product is 1, and the index of the last Product is ProductsCount. As a string, it is the name you assigned to the Product using the
AnyObject.Name property.
Returns:
The retrieved Product
Example:
This example retrieves in thisProduct the fifth Product and in thatProduct the Product named myProduct in the products of the FixTogether.
 Dim thisProduct As Product
 Set thisProduct = myFixTogether.GetProduct(5)
 Dim thatProduct As Product
 Set thatProduct = myFixTogether.GetProduct("myProduct")
 
o Sub RemoveFixTogether( iIndex)
Removes a FixTogether from the FixTogether.
Parameters:
iIndex
The index or the name of the FixTogether to remove from the FixTogether. As a numerics, this index is the rank of the FixTogether in the FixTogethers of the FixTogether. The index of the first FixTogether is 1, and the index of the last FixTogether is FixTogethersCount. As a string, it is the name you assigned to the FixTogether using the
AnyObject.Name property.
Example:
This example removes the last FixTogether of the FixTogether.
 fixTogether.RemoveFixTogether(fixTogether.FixTogethersCount)
 
o Sub RemoveProduct( iIndex)
Removes a Product from the FixTogether.
Parameters:
iIndex
The index or the name of the Product to remove from the FixTogether. As a numerics, this index is the rank of the Product in the products of the FixTogether. The index of the first Product is 1, and the index of the last Product is ProductsCount. As a string, it is the name you assigned to the FixTogether using the
AnyObject.Name property.
Example:
This example removes the last Product of the FixTogether.
 fixTogether.RemoveProduct(fixTogether.ProductsCount)
 

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