CIP C++ documentation for class "wfcWDetailNoteItem"

Class wfcWDetailNoteItem

# include <wfcDetail.h> class wfcWDetailNoteItem : public virtual wfcAnnotation, : public virtual pfcDetailNoteItem { xaideclare(wfcWDetailNoteItem) ... };

Description

Extends the functionality of pfcDetailNoteItem

This is the actual type of Detail Note Items in Object Toolkit.

Manual References:: Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes

Method Summary


`void`	`AddLeader (pfcDetailLeaderAttachment_ptr LeadrAttach)`
	Add a leader to the specified detail note.

`void`	`AddLeaderWithArrowType (pfcDetailLeaderAttachment_ptr LeadrAttach, wfcLeaderArrowType Type)`
	LICENSE: 222 Add a leader with arrow type to the specified detail note.

`optional pfcDetailSymbolInstItems_ptr`	`CollectSymbolInstances ()`
	Returns a list of all symbol instances which are declared in a detail note.

`wfcEnvelope3D_ptr`	`Get3DLineEnvelope (xint 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.

`wfcAnnotationPlane_ptr`	`GetAnnotationPlane ()`
	LICENSE: 222 Gets the annotation plane for the 3D notes (not applicable to 2D notes).

`pfcDetailNoteItem_ptr`	`GetAssociativeNoteInDrawing (pfcDrawing_ptr DrawingModel)`
	Get associative note in drawing for solid note.

`pfcDetailNoteItem_ptr`	`GetAssociativeNoteInSolid ()`
	Get associative note in solid for drawing note.

`optional pfcVector3D_ptr`	`GetElbowDirection ()`
	LICENSE: 222 Get direction of elbow for leader of the note.

`optional wfcGTol_ptr`	`GetGTol ()`
	Return the geometric tolerance shown in a detail note.

`wfcLeaderArrowTypes_ptr`	`GetLeaderArrowTypes ()`
	LICENSE: 222 Gets arrow types for all the leaders in a note.

`wfcLeaderStyle`	`GetLeaderStyle ()`
	LICENSE: 222 Get style of the leader.

`pfcVector3D_ptr`	`GetLegacyLeaderNoteDirection ()`


`xreal`	`GetLegacyLeaderNoteLength ()`


`void`	`RemoveLeader (xint index)`
	LICENSE: 222 Remove leader from detail note.

`void`	`SetAnnotationPlane (wfcAnnotationPlane_ptr AnnotPlane)`
	LICENSE: 222 Sets the annotation plane for the 3D notes. (not applicable to 2D notes).

`void`	`SetLeaderStyle (wfcLeaderStyle Style)`
	LICENSE: 222 Set style of the leader.

`void`	`SetLeadersWithArrowType (pfcDetailLeaderAttachments_ptr LeadrAttach, wfcLeaderArrowTypes_ptr Types)`
	LICENSE: 222 Modify note with specifed leaders and arrow types.

Methods Inherited from Class wfcLayerItem:: IsLayerItemVisible, RemoveNoUpdate, GetLayers, AddNoUpdate

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class wfcWParameterOwner:: ExportParameterTable, ApplyParameterTableset

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class wfcWRelationOwner:: GetRelationConstraints, UnitsUsed, UseUnits, EvaluateExpressionWithUnits

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcModelItem:: GetName, SetName, GetId, GetType

Methods Inherited from Class wfcWModelItem:: DeleteUserDefinedName, Unhide, Hide, IsHidden, IsNameReadOnly, IsZoneFeature, GetDefaultName

Methods Inherited from Class wfcAnnotation:: 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 Class pfcDetailItem:: GetDetailType, Delete

Methods Inherited from Class pfcDetailNoteItem:: 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 Detail

wfcLeaderArrowTypes_ptr GetLeaderArrowTypes ()

LICENSE: 222

Gets arrow types for all the leaders in a note.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - 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.

pfcXToolkitNoLicense - License check failure.

pfcXToolkitOutOfMemory - Not enough memory.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Note Placement, Annotations: Annotation Features and Annotations: Accessing Note Placement

Returns:

void SetLeadersWithArrowType (pfcDetailLeaderAttachments_ptr LeadrAttach, wfcLeaderArrowTypes_ptr Types)

LICENSE: 222

Modify note with specifed leaders and arrow types.

Exceptions thrown (but not limited to):

pfcXToolkitNoLicense - License check failure.

pfcXToolkitBadContext - Invalid leader type for this note attachment.

pfcXToolkitOutOfMemory - Not enough memory.

Manual References:: Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments, Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments

Parameters:

LeadrAttach: Leader attachments.
Types: arrow types.

Returns:

void AddLeader (pfcDetailLeaderAttachment_ptr LeadrAttach)

Add a leader to the specified detail note.

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - Not enough memory.

Manual References:: Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments, Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments

Parameters:

LeadrAttach: The leader.

Returns:

void AddLeaderWithArrowType (pfcDetailLeaderAttachment_ptr LeadrAttach, wfcLeaderArrowType Type)

LICENSE: 222

Add a leader with arrow type to the specified detail note.

Exceptions thrown (but not limited to):

pfcXToolkitNoLicense - License check failure.

pfcXToolkitBadContext - Invalid leader type for this note attachment.

pfcXToolkitOutOfMemory - Not enough memory.

Manual References:: Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments, Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments

Parameters:

LeadrAttach: Leader attachment
Type: arrow type.

Returns:

void RemoveLeader (xint index)

LICENSE: 222

Remove leader from detail note.

Exceptions thrown (but not limited to):

pfcXToolkitNoLicense - License check failure.

pfcXToolkitOutOfMemory - Not enough memory.

Manual References:: Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments, Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments

Parameters:

index: Index of leader. Indices starts from 0.

Returns:

optional pfcVector3D_ptr GetElbowDirection ()

LICENSE: 222

Get direction of elbow for leader of the note.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The note is not placed, or does not use leaders.

pfcXToolkitCantAccess - The note uses the default elbow length (this is possible for flat-to-screen notes only).

Manual References:: Annotations: Annotation Features and Annotations: Note Properties, Annotations: Annotation Features and Annotations: Note Properties

Returns:: Direction.

wfcLeaderStyle GetLeaderStyle ()

LICENSE: 222

Get style of the leader.

Exceptions thrown (but not limited to):

pfcXToolkitNoLicense - License check failure.

Manual References:: Annotations: Annotation Features and Annotations: Note Properties, Annotations: Annotation Features and Annotations: Note Properties

Returns:: Leader Style.

void SetLeaderStyle (wfcLeaderStyle Style)

LICENSE: 222

Set style of the leader.

Exceptions thrown (but not limited to):

pfcXToolkitNoLicense - License check failure.

Manual References:: Annotations: Annotation Features and Annotations: Note Properties, Annotations: Annotation Features and Annotations: Note Properties

Parameters:

Style: leader style.

Returns:

void SetAnnotationPlane (wfcAnnotationPlane_ptr AnnotPlane)

LICENSE: 222

Sets the annotation plane for the 3D notes. (not applicable to 2D notes).

Exceptions thrown (but not limited to):

pfcXToolkitNoLicense - License check failure.

Manual References:: Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments, Annotations: Annotation Features and Annotations: Modifying 3D Note Attachments

Parameters:

AnnotPlane: The annotation plane.

Returns:

wfcAnnotationPlane_ptr GetAnnotationPlane ()

LICENSE: 222

Gets the annotation plane for the 3D notes (not applicable to 2D notes).

Exceptions thrown (but not limited to):

pfcXToolkitNoLicense - License check failure.

Manual References:: Annotations: Annotation Features and Annotations: Accessing Note Placement

Returns:: The annotation plane.

pfcDetailNoteItem_ptr GetAssociativeNoteInDrawing (pfcDrawing_ptr DrawingModel)

Get associative note in drawing for solid note.

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The solid model is not contained in the drawing.

pfcXToolkitNotFound - The solid model note is not displayed in the drawing.

Manual References:: Drawings: Cross-referencing 3D Notes and Drawing Annotations, Drawings: Cross-referencing 3D Notes and Drawing Annotations

Parameters:

DrawingModel

Returns:: A note object owned by drawing.

pfcDetailNoteItem_ptr GetAssociativeNoteInSolid ()

Get associative note in solid for drawing note.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The detail note does not show a solid model note.

Manual References:: Drawings: Cross-referencing 3D Notes and Drawing Annotations, Drawings: Cross-referencing 3D Notes and Drawing Annotations

Returns:: A note object owned by solid.

wfcEnvelope3D_ptr Get3DLineEnvelope (xint 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.

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The indicated line does not exist.