API Documentation > Classes > Class pfcDetailNoteItem
Class pfcDetailNoteItem
Description
This interface represents a detail note item in a Creo Parametric model.
See Also:
Direct Parent Classes:
User Guide References:
Property Summary
/* readonly */ /* optional */ pfcDetailSymbolDefItem
The symbol definition that the note belongs to, or null if the note does not belong to a symbol definition.
Method Summary
void
Draw ()
Draws a detail note item. Drawn notes will be removed upon the next regeneration.
void
Erases a detail note item. Erased notes will be shown again after the next regeneration.
Gets attachment information of note.
/* optional */ number
Gets length of note leader elbow.
GetInstructions (boolean GiveParametersAsNames)
Returns a data object describing how a detail note item is constructed.
GetLineEnvelope (number LineNumber)
Returns the envelope of a line in the note, in screen coordinates.
GetModelReference (number LineNumber, number Index)
Returns the model referenced by parameterized text in a note.
/* optional */ pfcAnnotationTextStyle
Gets textstyle of note.
/* optional */ pfcModelItem
/* optional */ string
Get URL as part of note text. Availble only for 3D notes
boolean
Checks if note data is displayed. This is useful for notes whose owner is not displayed in session
boolean
Checks if note is read-only.
void
KeepArrowTypeAsIs (boolean ArrowType)
void
Modifies the definition of an existing detail note item.
void
Removes a detail note item. Removed notes will continue to be removed after the next regeneration.
void
SetDisplayed (boolean Display)
Sets note data displayed. This is useful for notes whose owner is not displayed in session.
void
SetElbow ( /* optional */ number Length, /* optional */ pfcVector3D Direction)
Set elbow to leader note.
void
Sets free attachment information of note.
void
Sets leader attachment information of note.
void
Sets textstyle of note.
void
Sets offset attachment information of note.
void
Sets on item attachment information of note.
void
SetReadOnly (boolean ReadOnly)
Sets note read-only.
void
void
SetURL (string URLText)
Set URL as part of note text. Availble only for 3D notes
void
Show ()
Shows a note. Shown notes will continue to be shown after the next regeneration.
Property Detail
/* readonly */ /* optional */ pfcDetailSymbolDefItem
SymbolDef
The symbol definition that the note belongs to, or null if the note does not belong to a symbol definition.
Method Detail
void
Draw
()
Draws a detail note item. Drawn notes will be removed upon the next regeneration.
The drawing must be current to use this method.
User Guide References:
void
Erase
()
Erases a detail note item. Erased notes will be shown again after the next regeneration.
The drawing must be current to use this method.
User Guide References:
GetAttachment
()
Gets attachment information of note.
Exceptions thrown (but not limited to):
pfcXToolkitOutOfMemory - Not enough memory.
pfcXToolkitNotFound - No leaders were found.
Returns:
User Guide References:
/* optional */ number
GetElbowLength
()
Gets length of note leader elbow.
Returns:
length.
User Guide References:
GetInstructions
(boolean GiveParametersAsNames)
Returns a data object describing how a detail note item 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. Creo Parametric does not resolve and replace symbolic callouts for notes, which are not displayed. Therefore, if the note is not displayed or is hidden in a layer, the text retrieved may contain symbolic callouts, even when GiveParametersAsNames is false.
Returns:
The instuctions data object.
User Guide References:
GetLineEnvelope
(number LineNumber)
Returns the envelope of a line in the note, in screen coordinates.
Exceptions thrown (but not limited to):
pfcXToolkitEmpty - The note is a blank string.
Parameters:
LineNumber
The line number to evaluate.
Returns:
The envelope, in screen coordinates. The order of coordinates are returned as:
0 -------- 1
| |
2 -------- 3
This ordering of points is preserved even if the note is mirrored and/or at an angle.
User Guide References:
GetModelReference
(number LineNumber, number Index)
Returns the model referenced by parameterized text in a note.
Parameters:
LineNumber
The line number where the parameterized text occurs.
Index
The index in the line for the parameterized text.
Returns:
The model referenced by the parameterized text.
User Guide References:
/* optional */ pfcAnnotationTextStyle
GetNoteTextStyle
()
Gets textstyle of note.
Returns:
Textstyle.
User Guide References:
/* optional */ pfcModelItem
GetOwner
()
Returns:
GetTextLines
(pfcDetailTextDisplayOption TxtDisplayOption)
Exceptions thrown (but not limited to):
pfcXToolkitOutOfMemory - Not enough memory.
pfcXToolkitNotFound - No text lines were found.
Parameters:
TxtDisplayOption
Returns:
User Guide References:
/* optional */ string
GetURL
()
Get URL as part of note text. Availble only for 3D notes
Returns:
URL.
boolean
IsDisplayed
()
Checks if note data is displayed. This is useful for notes whose owner is not displayed in session
Returns:
xtrue for notes marked as displayed.
User Guide References:
boolean
IsReadOnly
()
Checks if note is read-only.
Returns:
xtrue if read only.
User Guide References:
void
KeepArrowTypeAsIs
(boolean ArrowType)
Parameters:
ArrowType
User Guide References:
void
Modify
(pfcDetailNoteInstructions Instructions)
Modifies the definition of an existing detail note item.
Parameters:
Instructions
The instructions object describing the new detail note item.
User Guide References:
void
Remove
()
Removes a detail note item. Removed notes will continue to be removed after the next regeneration.
The drawing must be current to use this method. To remove a note that is in a non-current model, use the pfcDetailNoteInstructions attribute IsDisplayed, and regenerate the drawing.
User Guide References:
void
SetDisplayed
(boolean Display)
Sets note data displayed. This is useful for notes whose owner is not displayed in session.
Parameters:
Display
User Guide References:
void
SetElbow
( /* optional */ number Length, /* optional */ pfcVector3D Direction)
Set elbow to leader note.
Parameters:
Length
length of leader elbow.
Direction
direction of leader elbow.
User Guide References:
void
SetFreeAttachment
(pfcFreeAttachment Attachment)
Sets free attachment information of note.
Parameters:
Attachment
free attachment
User Guide References:
void
SetLeaders
(pfcLeaderAttachments LeaderAttachs)
Sets leader attachment information of note.
Exceptions thrown (but not limited to):
pfcXToolkitOutOfMemory - Not enough memory.
Parameters:
LeaderAttachs
leaders
void
SetNoteTextStyle
Sets textstyle of note.
Parameters:
TextStyle
Textstyle.
User Guide References:
void
SetOffsetAttachment
(pfcOffsetAttachment Attachment)
Sets offset attachment information of note.
Parameters:
Attachment
offset attachment
User Guide References:
void
SetOnItemAttachment
Sets on item attachment information of note.
Parameters:
Attachment
on item attachment
User Guide References:
void
SetReadOnly
(boolean ReadOnly)
Sets note read-only.
Parameters:
ReadOnly
User Guide References:
void
SetTextLines
(pfcDetailTextLines TextLines)
Exceptions thrown (but not limited to):
pfcXToolkitBadContext - The note text cannot be varied.
pfcXToolkitOutOfMemory - Not enough memory.
Parameters:
TextLines
User Guide References:
void
SetURL
(string URLText)
Set URL as part of note text. Availble only for 3D notes
Exceptions thrown (but not limited to):
pfcXToolkitCantWrite - Could not modify the given item because it has read-only access.
Parameters:
URLText
URL.
void
Show
()
Shows a note. Shown notes will continue to be shown after the next regeneration.
The drawing must be current to use this method. To show a note that is in a non-current model, use the pfcDetailNoteInstructions attribute IsDisplayed, and regenerate the drawing.
User Guide References:
Was this helpful?