CIP JAVA documentation for class "com.ptc.pfc.pfcNote.Note"

Interface Note

SUCCESSOR(S): DetailNoteItem

package com.ptc.pfc.pfcNote; public interface Note extends com.ptc.pfc.pfcModelItem.ModelItem

Description

Specifies the information for a solid model note.

Direct Known Subclasses:: WNote

Method Summary
`void`	`Delete ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailItem.Delete` Deletes the solid model note.
`void`	`Display (GraphicsMode Mode)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.Remove, DetailNoteItem.Erase, DetailNoteItem.Show, DetailNoteItem.Draw` Displays the solid model note.
`stringseq`	`GetLines ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.SetTextLines, DetailNoteItem.GetTextLines` Get method for attribute "Lines" The text of the note.
`/optional/ ModelItem`	`GetOwner ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.GetOwner` Returns the model item that owns the note.
`stringseq`	`GetText (boolean GiveParametersAsNames)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.GetTextLines` Returns the text of the solid model note.
`String`	`GetURL ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.SetURL, DetailNoteItem.GetURL` Get method for attribute "URL" The URL pointed to by the note.
`void`	`SetLines (stringseq value)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.SetTextLines, DetailNoteItem.GetTextLines` Set method for attribute "Lines" The text of the note.
`void`	`SetURL (String value)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.SetURL, DetailNoteItem.GetURL` Set method for attribute "URL" The URL pointed to by the note.

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`

Method Detail

GetLines/SetLines

`stringseq`	`GetLines`	`()`
`void`	`SetLines`	`(stringseq value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): DetailNoteItem.SetTextLines, DetailNoteItem.GetTextLines

The text of the note.

Using this to read the text of the note will always get the text in numeric form (parameter callouts will not be identified). To get the text with the parameter callouts, use Note.GetText(boolean)

Exceptions thrown (but not limited to):

XToolkitBadContext - The note text cannot be varied.

Manual References:: Solid: Annotations, Solid: Annotations, Solid: Annotations, Solid: Annotations

GetText

stringseq GetText (boolean GiveParametersAsNames)

DEPRECATED: since Creo 4
SUCCESSOR(S): DetailNoteItem.GetTextLines

Returns the text of the solid model note.

Manual References:: Solid: Annotations, Solid: Annotations

Parameters:

GiveParametersAsNames: If true, the text will indicate parameter callouts with ampersands ('&'). If false, the text will show the parameter values with no callout information.

Returns:

GetURL/SetURL

`String`	`GetURL`	`()`
`void`	`SetURL`	`(String value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): DetailNoteItem.SetURL, DetailNoteItem.GetURL

The URL pointed to by the note.

Exceptions thrown (but not limited to):

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

Manual References:: Solid: Annotations, Solid: Annotations, Solid: Annotations, Solid: Annotations

Display

void Display (GraphicsMode Mode)

DEPRECATED: since Creo 4
SUCCESSOR(S): DetailNoteItem.Remove, DetailNoteItem.Erase, DetailNoteItem.Show, DetailNoteItem.Draw

Displays the solid model note.

The model must be present in a window.

Manual References:: Solid: Annotations, Solid: Annotations

Parameters:

Mode: The mode in which to display the note. If the mode is DRAW_GRAPHICS_COMPLEMENT, the note will be erased if it was previous displayed.

Returns:

Delete

void Delete ()

DEPRECATED: since Creo 4
SUCCESSOR(S): DetailItem.Delete

Deletes the solid model note.

Exceptions thrown (but not limited to):

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

Manual References:: Solid: Annotations, Solid: Annotations

Returns:

GetOwner

/*optional*/ ModelItem GetOwner ()

DEPRECATED: since Creo 4
SUCCESSOR(S): DetailNoteItem.GetOwner

Returns the model item that owns the note.

Manual References:: Solid: Annotations, Solid: Annotations

Returns:: The owner, or null, if the note is not associated with a particular model item.