CIP Visual Basic.NET documentation for interface "IpfcDetailNoteItem"

Interface IpfcDetailNoteItem

Description

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

See Also:: IpfcDetailItemOwner.GetDetailItem(), IpfcDetailItemOwner.ListDetailItems(), IpfcDetailItemOwner.CreateDetailItem(), IpfcDetailSymbolDefItem.GetDetailItem(), IpfcDetailSymbolDefItem.ListDetailItems(), IpfcDetailSymbolDefItem.CreateDetailItem()

Direct Parent Classes:: IpfcDetailItem

Property Summary


`Property`	`SymbolDef`	`as IpfcDetailSymbolDefItem [readonly, optional]`
	The symbol definition that the note belongs to, or `null` if the note does not belong to a symbol definition.

Method Summary


`Sub`	`Draw ()`
	Draws a detail note item. Drawn notes will be removed upon the next regeneration.

`Sub`	`Erase ()`
	Erases a detail note item. Erased notes will be shown again after the next regeneration.

`Function`	`GetAttachment () as IpfcDetailAttachment`
	Gets attachment information of note.

`Function`	`GetElbowLength () as Double [optional]`
	Gets length of note leader elbow.

`Function`	`GetInstructions (GiveParametersAsNames as Boolean) as IpfcDetailNoteInstructions`
	Returns a data object describing how a detail note item is constructed.

`Function`	`GetLineEnvelope (LineNumber as Long) as IpfcEnvelope2D`
	Returns the envelope of a line in the note, in screen coordinates.

`Function`	`GetModelReference (LineNumber as Long, Index as Long) as IpfcModel`
	Returns the model referenced by parameterized text in a note.

`Function`	`GetNoteTextStyle () as IpfcAnnotationTextStyle [optional]`
	Gets textstyle of note.

`Function`	`GetOwner () as IpfcModelItem [optional]`


`Function`	`GetTextLines (TxtDisplayOption as IpfcDetailTextDisplayOption) as IpfcDetailTextLines`


`Function`	`GetURL () as String [optional]`
	Get URL as part of note text. Availble only for 3D notes

`Function`	`IsDisplayed () as Boolean`
	Checks if note data is displayed. This is useful for notes whose owner is not displayed in session

`Function`	`IsReadOnly () as Boolean`
	Checks if note is read-only.

`Sub`	`KeepArrowTypeAsIs (ArrowType as Boolean)`


`Sub`	`Modify (Instructions as IpfcDetailNoteInstructions)`
	Modifies the definition of an existing detail note item.

`Sub`	`Remove ()`
	Removes a detail note item. Removed notes will continue to be removed after the next regeneration.

`Sub`	`SetDisplayed (Display as Boolean)`
	Sets note data displayed. This is useful for notes whose owner is not displayed in session.

`Sub`	`SetElbow (Length as Double [optional], Direction as IpfcVector3D [optional])`
	Set elbow to leader note.

`Sub`	`SetFreeAttachment (Attachment as IpfcFreeAttachment)`
	Sets free attachment information of note.

`Sub`	`SetLeaders (LeaderAttachs as IpfcLeaderAttachments)`
	Sets leader attachment information of note.

`Sub`	`SetNoteTextStyle (TextStyle as IpfcAnnotationTextStyle)`
	Sets textstyle of note.

`Sub`	`SetOffsetAttachment (Attachment as IpfcOffsetAttachment)`
	Sets offset attachment information of note.

`Sub`	`SetOnItemAttachment (Attachment as IpfcParametricAttachment)`
	Sets on item attachment information of note.

`Sub`	`SetReadOnly (ReadOnly as Boolean)`
	Sets note read-only.

`Sub`	`SetTextLines (TextLines as IpfcDetailTextLines)`


`Sub`	`SetURL (URLText as String)`
	Set URL as part of note text. Availble only for 3D notes

`Sub`	`Show ()`
	Shows a note. Shown notes will continue to be shown after the next regeneration.

Property Detail

Property SymbolDef as IpfcDetailSymbolDefItem [readonly, optional]

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

Method Detail

Sub Draw ()

Draws a detail note item. Drawn notes will be removed upon the next regeneration.

The drawing must be current to use this method.

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

Function GetAttachment () as IpfcDetailAttachment

Gets attachment information of note.

Exceptions thrown (but not limited to):

IpfcXToolkitOutOfMemory - Not enough memory.

IpfcXToolkitNotFound - No leaders were found.

Returns:

Function GetElbowLength () as Double [optional]

Gets length of note leader elbow.

Returns:: length.

Function GetInstructions (GiveParametersAsNames as Boolean) as IpfcDetailNoteInstructions

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.

Function GetLineEnvelope (LineNumber as Long) as IpfcEnvelope2D

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

Exceptions thrown (but not limited to):

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

Function GetModelReference (LineNumber as Long, Index as Long) as IpfcModel

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.

Function GetNoteTextStyle () as IpfcAnnotationTextStyle [optional]

Gets textstyle of note.

Returns:: Textstyle.

Function GetOwner () as IpfcModelItem [optional]

Returns:

Function GetTextLines (TxtDisplayOption as IpfcDetailTextDisplayOption) as IpfcDetailTextLines

Exceptions thrown (but not limited to):

IpfcXToolkitOutOfMemory - Not enough memory.

IpfcXToolkitNotFound - No text lines were found.

Parameters:

TxtDisplayOption

Returns:

Function GetURL () as String [optional]

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

Returns:: URL.

Function IsDisplayed () as Boolean

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.

Function IsReadOnly () as Boolean

Checks if note is read-only.

Returns:: xtrue if read only.

Sub KeepArrowTypeAsIs (ArrowType as Boolean)

Parameters:

ArrowType

Sub Modify (Instructions as IpfcDetailNoteInstructions)

Modifies the definition of an existing detail note item.

Parameters:

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

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

Sub SetDisplayed (Display as Boolean)

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

Parameters:

Display

Sub SetElbow (Length as Double [optional], Direction as IpfcVector3D [optional])

Set elbow to leader note.

Parameters:

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

Sub SetFreeAttachment (Attachment as IpfcFreeAttachment)

Sets free attachment information of note.

Parameters:

Attachment: free attachment

Sub SetLeaders (LeaderAttachs as IpfcLeaderAttachments)

Sets leader attachment information of note.

Exceptions thrown (but not limited to):

IpfcXToolkitOutOfMemory - Not enough memory.

Parameters:

LeaderAttachs: leaders

Sub SetNoteTextStyle (TextStyle as IpfcAnnotationTextStyle)

Sets textstyle of note.

Parameters:

TextStyle: Textstyle.

Sub SetOffsetAttachment (Attachment as IpfcOffsetAttachment)

Sets offset attachment information of note.

Parameters:

Attachment: offset attachment

Sub SetOnItemAttachment (Attachment as IpfcParametricAttachment)

Sets on item attachment information of note.

Parameters:

Attachment: on item attachment

Sub SetReadOnly (ReadOnly as Boolean)

Sets note read-only.

Parameters:

ReadOnly

Sub SetTextLines (TextLines as IpfcDetailTextLines)

Exceptions thrown (but not limited to):

IpfcXToolkitBadContext - The note text cannot be varied.

IpfcXToolkitOutOfMemory - Not enough memory.

Parameters:

TextLines

Sub SetURL (URLText as String)

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

Exceptions thrown (but not limited to):

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

Parameters:

URLText: URL.

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