Interface WDetailSymbolInstItem
package com.ptc.wfc.wfcDetail;
public interface WDetailSymbolInstItem
extends com.ptc.wfc.wfcAnnotation.Annotation,
com.ptc.pfc.pfcDetail.DetailSymbolInstItem
Description
Extends the functionality of DetailSymbolInstItem
This is the actual type of Detail SymbolInst Items in Object Toolkit.
Methods Inherited from Interface com.ptc.wfc.wfcLayerState.LayerItem :
Methods Inherited from Interface com.ptc.pfc.pfcBase.ActionSource :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Parent :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ParameterOwner :
Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WParameterOwner :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.RelationOwner :
Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WRelationOwner :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Child :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ModelItem :
Methods Inherited from Interface com.ptc.wfc.wfcModelItem.WModelItem :
Methods Inherited from Interface com.ptc.wfc.wfcAnnotation.Annotation :
ShowInDrawing, Display, DisplayInDrawing, Undisplay, UndisplayInDrawing, IsShown, Update, GetTextStyle, SetTextStyle, GetTextStyleInDrawing, SetTextStyleInDrawing, UpdateAttachment, UpdatePosition, IsAssociative, GetAttachmentAssociativity, GetAnnotationElement, IsInactive, Rotate, ConvertLegacy, NeedsConversion, GetSecurityMarking, SetSecurityMarking, IsUsingXSecReference
Methods Inherited from Interface com.ptc.pfc.pfcDetail.DetailItem :
Methods Inherited from Interface com.ptc.pfc.pfcDetail.DetailSymbolInstItem :
Method Summary
void | |
void | |
Add variable text to the symbol instance. | |
LICENSE: 222 | |
/*optional*/ Dimension | |
Finds the dimension to which the symbol instance is directly attached. | |
LICENSE: 222 Gets data of an entity in the symbol instance. | |
/*optional*/ Feature | GetFeature () |
Return the feature that is shown the detail symbol instance. | |
LICENSE: 222 Gets data of a note in the symbol instance. | |
void | |
LICENSE: 222 |
Method Detail
GetAttachedDimension | ||
/*optional*/ Dimension | GetAttachedDimension | () |
Finds the dimension to which the symbol instance is directly attached.
Exceptions thrown (but not limited to):
XToolkitNotExist - The symbol instance is not placed on item to a dimension
XToolkitBadContext - The symbol instance is placed on a dim but we are unable to fill in the output structure on account of the dimension's model being missing (perhaps it was suppressed in the assembly).
Returns:
The dimension to which the symbol instance is directly attached.
AddLeader | ||
void | AddLeader |
Exceptions thrown (but not limited to):
XToolkitOutOfMemory - Not enough memory.
Parameters:
LeaderAttach
Returns:
AddVarText | ||
void | AddVarText |
Add variable text to the symbol instance.
Exceptions thrown (but not limited to):
XToolkitOutOfMemory - Not enough memory.
Parameters:
Text
The variable text.
Returns:
GetFeature | ||
/*optional*/ Feature | GetFeature | () |
Return the feature that is shown the detail symbol instance.
Exceptions thrown (but not limited to):
XToolkitNotFound - The symbol instance is not generated from a solid model feature.
Returns:
The feature (i.e. weld feature) that produces the symbol.
SetAnnotationPlane | ||
void | SetAnnotationPlane |
Exceptions thrown (but not limited to):
XToolkitBadContext - Annotation plane is not appropriate for this data.
User Guide References:
Parameters:
AnnotPlane
Returns:
GetAnnotationPlane | ||
GetAnnotationPlane | () |
Exceptions thrown (but not limited to):
XToolkitBadContext - Annotation plane is not appropriate for this data.
User Guide References:
Returns:
GetEntityInstructions | ||
GetEntityInstructions |
Gets data of an entity in the symbol instance.
Exceptions thrown (but not limited to):
XToolkitNotFound - No symbols were found in the model.
Parameters:
Item
The entity attached to symbol instance.
Returns:
The entity data in symbol instance space.
GetNoteInstructions | ||
GetNoteInstructions |
Gets data of a note in the symbol instance.
Exceptions thrown (but not limited to):
XToolkitNotFound - No symbols were found in the model.
Parameters:
Item
The pfcDetailNoteItem attached to symbol instance.
DispMode
The display mode.
Returns:
The note data in symbol instance space encapsulated in pfcDetailNoteInstructions_ptr.