Library | Module

Interface IpfcDetailSymbolGroup



Description

This interface represents a symbol group contained in a drawing symbol.
Direct Parent Classes:
IpfcObject



Property Summary

PropertyParentDefinitionas IpfcDetailSymbolDefItem
The symbol definition of the given group.
PropertyParentGroupas IpfcDetailSymbolGroup [readonly, optional]
The parent symbol group of the level to which the given group belongs.



Method Summary

SubDelete ()
To delete the given symbol group.
FunctionGetInstructions () as IpfcDetailSymbolGroupInstructions
To get the instructions object describing how the symbol group is constructed.
FunctionListChildren () as IpfcDetailSymbolGroups [optional]
To list the subgroups of the given symbol group.
SubModify (Instructions as IpfcDetailSymbolGroupInstructions)
To modify the given symbol group.



Property Detail


PropertyParentDefinitionas IpfcDetailSymbolDefItem

The symbol definition of the given group.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The group is a top level group and does not have a parent.






PropertyParentGroupas IpfcDetailSymbolGroup [readonly, optional]

The parent symbol group of the level to which the given group belongs.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - The group is a top level group and does not have a parent.







Method Detail


SubDelete ()

To delete the given symbol group.



FunctionGetInstructions () as IpfcDetailSymbolGroupInstructions

To get the instructions object describing how the symbol group is constructed.
Returns:
The symbol group instructions object.



FunctionListChildren () as IpfcDetailSymbolGroups [optional]

To list the subgroups of the given symbol group.

Exceptions thrown (but not limited to):

IpfcXToolkitNotFound - No groups are stored in the symbol definition at this level.


Returns:
The list of sub groups.



SubModify (Instructions as IpfcDetailSymbolGroupInstructions)

To modify the given symbol group.
Parameters:
Instructions
The instructions for modification of symbol group.