Interface WDetailNoteItem
package com.ptc.wfc.wfcDetail;
public interface WDetailNoteItem
extends com.ptc.wfc.wfcAnnotation.Annotation,
com.ptc.pfc.pfcDetail.DetailNoteItem
Description
Extends the functionality of DetailNoteItem
This is the actual type of Detail Note Items in Object Toolkit.
User Guide References:
Detail Note Data:WDetailNoteItem, Note Properties:WDetailNoteItem, Accessing Note Placement:WDetailNoteItem, Modifying 3D Note Attachments:WDetailNoteItem
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.DetailNoteItem :
GetSymbolDef, Draw, Show, Erase, Remove, GetInstructions, Modify, GetTextLines, SetTextLines, SetDisplayed, IsDisplayed, IsReadOnly, SetReadOnly, GetAttachment, SetFreeAttachment, SetOffsetAttachment, SetOnItemAttachment, SetLeaders, SetElbow, GetElbowLength, GetNoteTextStyle, SetNoteTextStyle, GetLineEnvelope, GetModelReference, SetURL, GetURL, GetOwner, KeepArrowTypeAsIs
Method Summary
void | |
Add a leader to the specified detail note. | |
void | |
LICENSE: 222 Add a leader with arrow type to the specified detail note. | |
/*optional*/ DetailSymbolInstItems | |
Returns a list of all symbol instances which are declared in a detail note. | |
Get3DLineEnvelope (int LineNumber) | |
LICENSE: 222 Line envelope for note. The order of coordinates in the envelope is: 0 ----------------------------1 | | 2 ----------------------------3 This ordering of coordinates is preserved even if the text is mirrored or applied at a rotation angle. | |
LICENSE: 222 Gets the annotation plane for the 3D notes (not applicable to 2D notes). | |
Get associative note in drawing for solid note. | |
Get associative note in solid for drawing note. | |
/*optional*/ Vector3D | |
LICENSE: 222 Get direction of elbow for leader of the note. | |
/*optional*/ GTol | GetGTol () |
Return the geometric tolerance shown in a detail note. | |
LICENSE: 222 Gets arrow types for all the leaders in a note. | |
LICENSE: 222 Get style of the leader. | |
double | |
void | RemoveLeader (int index) |
LICENSE: 222 Remove leader from detail note. | |
void | |
LICENSE: 222 Sets the annotation plane for the 3D notes. (not applicable to 2D notes). | |
void | |
LICENSE: 222 Set style of the leader. | |
void | |
LICENSE: 222 Modify note with specifed leaders and arrow types. |
Method Detail
GetLeaderArrowTypes | ||
GetLeaderArrowTypes | () |
Gets arrow types for all the leaders in a note.
Exceptions thrown (but not limited to):
XToolkitNotFound - No leaders were found. OR The note attachment structure does not have any leader endpoints. OR This attachment is not a leader and does not include an arrow.
XToolkitNoLicense - License check failure.
XToolkitOutOfMemory - Not enough memory.
User Guide References:
Returns:
SetLeadersWithArrowType | ||
void | SetLeadersWithArrowType |
Modify note with specifed leaders and arrow types.
Exceptions thrown (but not limited to):
XToolkitNoLicense - License check failure.
XToolkitBadContext - Invalid leader type for this note attachment.
XToolkitOutOfMemory - Not enough memory.
User Guide References:
Parameters:
LeadrAttach
Leader attachments.
Types
arrow types.
Returns:
AddLeader | ||
void | AddLeader |
Add a leader to the specified detail note.
Exceptions thrown (but not limited to):
XToolkitOutOfMemory - Not enough memory.
User Guide References:
Parameters:
LeadrAttach
The leader.
Returns:
AddLeaderWithArrowType | ||
void | AddLeaderWithArrowType |
Add a leader with arrow type to the specified detail note.
Exceptions thrown (but not limited to):
XToolkitNoLicense - License check failure.
XToolkitBadContext - Invalid leader type for this note attachment.
XToolkitOutOfMemory - Not enough memory.
User Guide References:
Parameters:
LeadrAttach
Leader attachment
Type
arrow type.
Returns:
RemoveLeader | ||
void | RemoveLeader | (int index) |
Remove leader from detail note.
Exceptions thrown (but not limited to):
XToolkitNoLicense - License check failure.
XToolkitOutOfMemory - Not enough memory.
User Guide References:
Parameters:
index
Index of leader. Indices starts from 0.
Returns:
GetElbowDirection | ||
/*optional*/ Vector3D | GetElbowDirection | () |
Get direction of elbow for leader of the note.
Exceptions thrown (but not limited to):
XToolkitNotFound - The note is not placed, or does not use leaders.
XToolkitCantAccess - The note uses the default elbow length (this is possible for flat-to-screen notes only).
User Guide References:
Returns:
Direction.
GetLeaderStyle | ||
GetLeaderStyle | () |
Get style of the leader.
Exceptions thrown (but not limited to):
XToolkitNoLicense - License check failure.
User Guide References:
Returns:
Leader Style.
SetLeaderStyle | ||
void | SetLeaderStyle |
Set style of the leader.
Exceptions thrown (but not limited to):
XToolkitNoLicense - License check failure.
User Guide References:
Parameters:
Style
leader style.
Returns:
SetAnnotationPlane | ||
void | SetAnnotationPlane |
Sets the annotation plane for the 3D notes. (not applicable to 2D notes).
Exceptions thrown (but not limited to):
XToolkitNoLicense - License check failure.
User Guide References:
Parameters:
AnnotPlane
The annotation plane.
Returns:
GetAnnotationPlane | ||
GetAnnotationPlane | () |
Gets the annotation plane for the 3D notes (not applicable to 2D notes).
Exceptions thrown (but not limited to):
XToolkitNoLicense - License check failure.
User Guide References:
Returns:
The annotation plane.
GetAssociativeNoteInDrawing | ||
GetAssociativeNoteInDrawing |
Get associative note in drawing for solid note.
Exceptions thrown (but not limited to):
XToolkitBadContext - The solid model is not contained in the drawing.
XToolkitNotFound - The solid model note is not displayed in the drawing.
Parameters:
DrawingModel
Returns:
A note object owned by drawing.
GetAssociativeNoteInSolid | ||
GetAssociativeNoteInSolid | () |
Get associative note in solid for drawing note.
Exceptions thrown (but not limited to):
XToolkitNotFound - The detail note does not show a solid model note.
Returns:
A note object owned by solid.
Get3DLineEnvelope | ||
Get3DLineEnvelope | (int LineNumber) |
Line envelope for note. The order of coordinates in the envelope is:
0 ----------------------------1
| |
2 ----------------------------3
This ordering of coordinates is preserved even if the text is mirrored or applied at a rotation angle.
Exceptions thrown (but not limited to):
XToolkitNotFound - The indicated line does not exist.
User Guide References:
Parameters:
LineNumber
line number.
Returns:
Line envelope.
CollectSymbolInstances | ||
/*optional*/ DetailSymbolInstItems | CollectSymbolInstances | () |
Returns a list of all symbol instances which are declared in a detail note.
The instances are returned in the order they are encountered in the note text.
Exceptions thrown (but not limited to):
XToolkitNotFound - There are no symbol instances generated as a callout in this note.
User Guide References:
Returns:
Symbol instances declared in the note.
GetLegacyLeaderNoteLength | ||
double | GetLegacyLeaderNoteLength | () |
Exceptions thrown (but not limited to):
XToolkitInvalidType - This note is not a directed (normal or tangent) leader type note or is in an annotaton plane.
User Guide References:
Returns:
GetLegacyLeaderNoteDirection | ||
GetLegacyLeaderNoteDirection | () |
Exceptions thrown (but not limited to):
XToolkitInvalidType - This note is not a directed (normal or tangent) leader type note or is in an annotaton plane.
User Guide References:
Returns:
GetGTol | ||
/*optional*/ GTol | GetGTol | () |
Return the geometric tolerance shown in a detail note.
User Guide References:
Returns:
The geometric tolerance handle