CIP JavaScript documentation for class " pfcNote"

Class pfcNote

DEPRECATED: since Creo 4SUCCESSOR(S): DetailNoteItemDescription

Specifies the information for a solid model note.

Property Summary


`stringseq`	`Lines`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.SetTextLines, DetailNoteItem.GetTextLines`
The text of the note.

`string`	`URL`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.SetURL, DetailNoteItem.GetURL`
The URL pointed to by the note.

Method Summary


`void`	`Delete ()`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailItem.Delete`
Deletes the solid model note.

`void`	`Display (pfcGraphicsMode Mode)`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.Remove, DetailNoteItem.Erase, DetailNoteItem.Show, DetailNoteItem.Draw`
Displays the solid model note.

`/* optional */ pfcModelItem`	`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.

Property Detail

stringseq Lines


`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 `pfcNote.GetText()` Exceptions thrown (but not limited to): `pfcXToolkitBadContext` - The note text cannot be varied.

string URL


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.SetURL, DetailNoteItem.GetURL`
The URL pointed to by the note. Exceptions thrown (but not limited to): `pfcXToolkitCantWrite` - Could not modify the given item because it has read-only access.

Method Detail

void Delete ()


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailItem.Delete`
Deletes the solid model note. Exceptions thrown (but not limited to): `pfcXToolkitCantWrite` - Could not delete the given item because it has read-only access.

void Display (pfcGraphicsMode 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. 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.

/* optional */ pfcModelItem GetOwner ()


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.GetOwner`
Returns the model item that owns the note. Returns: The owner, or `null`, if the note is not associated with a particular model item.

stringseq GetText (boolean GiveParametersAsNames)


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.GetTextLines`
Returns the text of the solid model note. 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: