CIP JAVA documentation for class "com.ptc.pfc.pfcDetail.DetailNoteItem"

Interface DetailNoteItem

package com.ptc.pfc.pfcDetail; public interface DetailNoteItem extends com.ptc.pfc.pfcDetail.DetailItem

Description

This interface represents a detail note item in a Creo Parametric model.

See Also:: DetailItemOwner.GetDetailItem(DetailType, int), DetailItemOwner.ListDetailItems(/*optional*/ DetailType, /*optional*/ Integer), DetailItemOwner.CreateDetailItem(DetailCreateInstructions), DetailSymbolDefItem.GetDetailItem(DetailType, int), DetailSymbolDefItem.ListDetailItems(/*optional*/ DetailType), DetailSymbolDefItem.CreateDetailItem(DetailCreateInstructions)

Direct Known Subclasses:: WDetailNoteItem

Method Summary
`void`	`Draw ()` Draws a detail note item. Drawn notes will be removed upon the next regeneration.
`void`	`Erase ()` Erases a detail note item. Erased notes will be shown again after the next regeneration.
`DetailAttachment`	`GetAttachment ()` Gets attachment information of note.
`/optional/ Double`	`GetElbowLength ()` Gets length of note leader elbow.
`DetailNoteInstructions`	`GetInstructions (boolean GiveParametersAsNames)` Returns a data object describing how a detail note item is constructed.
`Envelope2D`	`GetLineEnvelope (int LineNumber)` Returns the envelope of a line in the note, in screen coordinates.
`Model`	`GetModelReference (int LineNumber, int Index)` Returns the model referenced by parameterized text in a note.
`/optional/ AnnotationTextStyle`	`GetNoteTextStyle ()` Gets textstyle of note.
`/optional/ ModelItem`	`GetOwner ()`
`/optional/ DetailSymbolDefItem`	`GetSymbolDef ()` Get method for attribute "SymbolDef" The symbol definition that the note belongs to, or `null` if the note does not belong to a symbol definition.
`DetailTextLines`	`GetTextLines (DetailTextDisplayOption TxtDisplayOption)`
`/optional/ String`	`GetURL ()` Get URL as part of note text. Availble only for 3D notes
`boolean`	`IsDisplayed ()` Checks if note data is displayed. This is useful for notes whose owner is not displayed in session
`boolean`	`IsReadOnly ()` Checks if note is read-only.
`void`	`KeepArrowTypeAsIs (boolean ArrowType)`
`void`	`Modify (DetailNoteInstructions Instructions)` Modifies the definition of an existing detail note item.
`void`	`Remove ()` 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/ Double Length, /optional/ Vector3D Direction)` Set elbow to leader note.
`void`	`SetFreeAttachment (FreeAttachment Attachment)` Sets free attachment information of note.
`void`	`SetLeaders (LeaderAttachments LeaderAttachs)` Sets leader attachment information of note.
`void`	`SetNoteTextStyle (AnnotationTextStyle TextStyle)` Sets textstyle of note.
`void`	`SetOffsetAttachment (OffsetAttachment Attachment)` Sets offset attachment information of note.
`void`	`SetOnItemAttachment (ParametricAttachment Attachment)` Sets on item attachment information of note.
`void`	`SetReadOnly (boolean ReadOnly)` Sets note read-only.
`void`	`SetTextLines (DetailTextLines TextLines)`
`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.

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Child`
`GetDBParent`, `GetOId`

Methods Inherited from Interface `com.ptc.pfc.pfcBase.ActionSource`
`AddActionListener`, `RemoveActionListener`, `AddActionListenerWithType`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.RelationOwner`
`DeleteRelations`, `GetRelations`, `SetRelations`, `RegenerateRelations`, `EvaluateExpression`

Methods Inherited from Interface `com.ptc.pfc.pfcObject.Parent`
`GetChild`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ParameterOwner`
`GetParam`, `CreateParam`, `ListParams`, `SelectParam`, `CreateParamWithUnits`, `SelectParameters`

Methods Inherited from Interface `com.ptc.pfc.pfcModelItem.ModelItem`
`GetName`, `SetName`, `GetId`, `GetType`

Methods Inherited from Interface `com.ptc.pfc.pfcDetail.DetailItem`
`GetDetailType`, `Delete`

Method Detail

GetSymbolDef

/*optional*/ DetailSymbolDefItem GetSymbolDef ()

The symbol definition that the note belongs to, or null if the note does not belong to a symbol definition.

Manual References:: Drawings: Detail Notes Information, Drawings: Detail Notes Information

Draw

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.

Manual References:: Drawings: Details Notes Operations, Drawings: Details Notes Operations

Returns:

Show

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 DetailNoteInstructions attribute IsDisplayed, and regenerate the drawing.

Manual References:: Drawings: Details Notes Operations, Drawings: Details Notes Operations

Returns:

Erase

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.

Manual References:: Drawings: Details Notes Operations, Drawings: Details Notes Operations

Returns:

Remove

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 DetailNoteInstructions attribute IsDisplayed, and regenerate the drawing.

Manual References:: Drawings: Details Notes Operations, Drawings: Details Notes Operations

Returns:

GetInstructions

DetailNoteInstructions GetInstructions (boolean GiveParametersAsNames)

Returns a data object describing how a detail note item is constructed.

Manual References:: Drawings: Detail Notes Information, Drawings: Detail Notes Information

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.

Modify

void Modify (DetailNoteInstructions Instructions)

Modifies the definition of an existing detail note item.

Manual References:: Drawings: Instructions, Drawings: Details Notes Operations

Parameters:

Instructions: The instructions object describing the new detail note item.

Returns:

GetTextLines

DetailTextLines GetTextLines (DetailTextDisplayOption TxtDisplayOption)

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - Not enough memory.

XToolkitNotFound - No text lines were found.

Parameters:

TxtDisplayOption

Returns:

SetTextLines

void SetTextLines (DetailTextLines TextLines)

Exceptions thrown (but not limited to):

XToolkitBadContext - The note text cannot be varied.

XToolkitOutOfMemory - Not enough memory.

Parameters:

TextLines

Returns:

SetDisplayed

void SetDisplayed (boolean Display)

Sets note data displayed. This is useful for notes whose owner is not displayed in session.

Parameters:

Display

Returns:

IsDisplayed

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.

IsReadOnly

boolean IsReadOnly ()

Checks if note is read-only.

Returns:: xtrue if read only.

SetReadOnly

void SetReadOnly (boolean ReadOnly)

Sets note read-only.

Parameters:

ReadOnly

Returns:

GetAttachment

DetailAttachment GetAttachment ()

Gets attachment information of note.

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - Not enough memory.

XToolkitNotFound - No leaders were found.

Returns:

SetFreeAttachment

void SetFreeAttachment (FreeAttachment Attachment)

Sets free attachment information of note.

Parameters:

Attachment: free attachment

Returns:

SetOffsetAttachment

void SetOffsetAttachment (OffsetAttachment Attachment)

Sets offset attachment information of note.

Parameters:

Attachment: offset attachment

Returns:

SetOnItemAttachment

void SetOnItemAttachment (ParametricAttachment Attachment)

Sets on item attachment information of note.

Parameters:

Attachment: on item attachment

Returns:

SetLeaders

void SetLeaders (LeaderAttachments LeaderAttachs)

Sets leader attachment information of note.

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - Not enough memory.

Parameters:

LeaderAttachs: leaders

Returns:

SetElbow

void SetElbow ( /*optional*/ Double Length, /*optional*/ Vector3D Direction)

Set elbow to leader note.

Parameters:

Length: length of leader elbow.
Direction: direction of leader elbow.

Returns:

GetElbowLength

/*optional*/ Double GetElbowLength ()

Gets length of note leader elbow.

Returns:: length.

GetNoteTextStyle

/*optional*/ AnnotationTextStyle GetNoteTextStyle ()

Gets textstyle of note.

Manual References:: Drawings: Detail Note Data, Drawings: Detail Note Data

Returns:: Textstyle.

SetNoteTextStyle

void SetNoteTextStyle (AnnotationTextStyle TextStyle)

Sets textstyle of note.

Manual References:: Drawings: Detail Note Data

Parameters:

TextStyle: Textstyle.

Returns:

GetLineEnvelope

Envelope2D GetLineEnvelope (int LineNumber)

Returns the envelope of a line in the note, in screen coordinates.

Exceptions thrown (but not limited to):

XToolkitEmpty - The note is a blank string.

Manual References:: Drawings: Detail Notes Information, Drawings: Detail Notes Information

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.

GetModelReference

Model GetModelReference (int LineNumber, int Index)

Returns the model referenced by parameterized text in a note.

Manual References:: Drawings: Detail Notes Information

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.

SetURL

void SetURL (String URLText)

Set URL as part of note text. Availble only for 3D notes

Exceptions thrown (but not limited to):

XToolkitCantWrite - Could not modify the given item because it has read-only access.

Parameters:

URLText: URL.

Returns:

GetURL

/*optional*/ String GetURL ()

Get URL as part of note text. Availble only for 3D notes

Returns:: URL.

GetOwner

/*optional*/ ModelItem GetOwner ()

Returns:

KeepArrowTypeAsIs

void KeepArrowTypeAsIs (boolean ArrowType)

Manual References:: Drawings: Details Notes Operations, Drawings: Details Notes Operations

Parameters:

ArrowType

Returns: