Interface DetailSymbolInstItem
package com.ptc.pfc.pfcDetail;
public interface DetailSymbolInstItem
extends com.ptc.pfc.pfcDetail.DetailItem
Description
This interface represents a symbol instance in a Creo Parametric model.
See Also:
DetailItemOwner.GetDetailItem(DetailType, int), DetailItemOwner.ListDetailItems(/*optional*/ DetailType, /*optional*/ Integer), DetailItemOwner.CreateDetailItem(DetailCreateInstructions)
Direct Known Subclasses:
User Guide References:
Detail Symbol Instances:DetailSymbolInstItem, Instructions:DetailSymbolInstItem, Detail Symbol Instances Information:DetailSymbolInstItem, Detail Symbol Instances Operations:DetailSymbolInstItem, Detail Symbol Group Information:DetailSymbolInstItem, Creating, Reading and Modifying 3D Symbols:DetailSymbolInstItem
Methods Inherited from Interface com.ptc.pfc.pfcObject.Child :
Methods Inherited from Interface com.ptc.pfc.pfcBase.ActionSource :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.RelationOwner :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Parent :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ParameterOwner :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ModelItem :
Methods Inherited from Interface com.ptc.pfc.pfcDetail.DetailItem :
Method Summary
void | Draw () |
Draws a symbol instance. | |
void | Erase () |
Erases a symbol instance. | |
GetInstructions (boolean GiveParametersAsNames) | |
Returns a data object detailing how a symbol instance is constructed. | |
/*optional*/ DetailSymbolGroups | |
List the symbol groups included in a symbol instance. | |
void | |
Modifies the definition of a symbol instance. | |
void | Remove () |
Removes a symbol instance. | |
void | Show () |
Shows a symbol instance. |
Method Detail
Draw | ||
void | Draw | () |
Draws a symbol instance.
User Guide References:
Returns:
Erase | ||
void | Erase | () |
Erases a symbol instance.
User Guide References:
Returns:
Show | ||
void | Show | () |
Shows a symbol instance.
User Guide References:
Returns:
Remove | ||
void | Remove | () |
Removes a symbol instance.
User Guide References:
Returns:
GetInstructions | ||
GetInstructions | (boolean GiveParametersAsNames) |
Returns a data object detailing how a symbol instance is constructed.
User Guide References:
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.
Modify | ||
void | Modify |
Modifies the definition of a symbol instance.
Exceptions thrown (but not limited to):
XToolkitCantWrite - Could not modify the given item because it has read-only access.
User Guide References:
Parameters:
Instructions
Data object containing the new placement instructions for the instance.
Returns:
ListGroups | ||
/*optional*/ DetailSymbolGroups | ListGroups |
List the symbol groups included in a symbol instance.
Exceptions thrown (but not limited to):
XToolkitNotFound - No groups with the designated status were found in the symbol instance.
User Guide References:
Parameters:
Filter
The type of symbol groups to be listed.
Returns:
The list of symbol groups.