Library | ModuleFrames | Expand

Interface IpfcDetailGroupInstructions


Description

This interface contains information used to describe a detail group item. It may be used when creating detail groups (IpfcDetailItemOwner.CreateDetailItem()), or accessing existing groups (IpfcDetailGroupItem.Modify() and IpfcDetailGroupItem.GetInstructions()).
Direct Parent Classes:
IpfcDetailCreateInstructions


Property Summary

PropertyElementsas IpfcDetailItems
Sequence of detail items contained in the group.
PropertyIsDisplayedas Boolean [optional]
true if the group is displayed in the drawing, otherwise false.
PropertyNameas String
The name of the detail group.


Method Summary

FunctionCCpfcDetailGroupInstructions.Create (inName as String, inElements as IpfcDetailItems) as IpfcDetailGroupInstructions
Creates an instructions data object used to describe the construction of a detail group, for use in the methods IpfcDetailItemOwner.CreateDetailItem() and IpfcDetailGroupItem.Modify().


Property Detail

PropertyElementsas IpfcDetailItems

Sequence of detail items contained in the group.

Exceptions thrown (but not limited to):

IpfcXToolkitInvalidType - Invalid type of one of item.

IpfcXToolkitOutOfMemory - Not enough memory.

IpfcXToolkitNotFound - The group does not contain any items.





PropertyIsDisplayedas Boolean [optional]

true if the group is displayed in the drawing, otherwise false.


PropertyNameas String

The name of the detail group.



Method Detail

FunctionCCpfcDetailGroupInstructions.Create (inName as String, inElements as IpfcDetailItems) as IpfcDetailGroupInstructions

Creates an instructions data object used to describe the construction of a detail group, for use in the methods IpfcDetailItemOwner.CreateDetailItem() and IpfcDetailGroupItem.Modify().
Parameters:
inName
The name of the group to create.
inElements
Sequence of detail items (these must be entities, groups or notes).
Returns:
The instructions data object.