Interface IpfcDetailSymbolInstItem
Description
This interface represents a symbol instance in a Creo Parametric model.
See Also:
IpfcDetailItemOwner.GetDetailItem(), IpfcDetailItemOwner.ListDetailItems(), IpfcDetailItemOwner.CreateDetailItem()
Direct Parent Classes:
User Guide References:
Detail Symbol Instances:IpfcDetailSymbolInstItem, Instructions:IpfcDetailSymbolInstItem, Detail Symbol Instances Information:IpfcDetailSymbolInstItem, Detail Symbol Instances Operations:IpfcDetailSymbolInstItem
Method Summary
Sub | Draw () |
Draws a symbol instance. | |
Sub | Erase () |
Erases a symbol instance. | |
Function | |
Returns a data object detailing how a symbol instance is constructed. | |
Function | |
List the symbol groups included in a symbol instance. | |
Sub | |
Modifies the definition of a symbol instance. | |
Sub | Remove () |
Removes a symbol instance. | |
Sub | Show () |
Shows a symbol instance. |
Method Detail
Sub | Draw | () |
Draws a symbol instance.
User Guide References:
Sub | Erase | () |
Erases a symbol instance.
User Guide References:
Function | GetInstructions | (GiveParametersAsNames as Boolean) as IpfcDetailSymbolInstInstructions |
Returns a data object detailing how a symbol instance is constructed.
Parameters:
GiveParametersAsNames
true to get symbolic representations of parameter entries in the text, false to get the actual text shown to the user.
Returns:
The instructions data object.
User Guide References:
Function | ListGroups |
List the symbol groups included in a symbol instance.
Exceptions thrown (but not limited to):
IpfcXToolkitNotFound - No groups with the designated status were found in the symbol instance.
Parameters:
Filter
The type of symbol groups to be listed.
Returns:
The list of symbol groups.
Sub | Modify |
Modifies the definition of a symbol instance.
Exceptions thrown (but not limited to):
IpfcXToolkitCantWrite - Could not modify the given item because it has read-only access.
Parameters:
Instructions
Data object containing the new placement instructions for the instance.
User Guide References:
Sub | Remove | () |
Removes a symbol instance.
User Guide References:
Sub | Show | () |
Shows a symbol instance.
User Guide References: