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:
Methods Inherited from Interface com.ptc.pfc.pfcObject.Child :
Methods Inherited from Interface com.ptc.pfc.pfcBase.ActionSource :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.RelationOwner :
Methods Inherited from Interface com.ptc.pfc.pfcObject.Parent :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ParameterOwner :
Methods Inherited from Interface com.ptc.pfc.pfcModelItem.ModelItem :
Method Summary
void | Delete () |
DEPRECATED: since Creo 4 SUCCESSOR(S): DetailItem.Delete Deletes the solid model note. | |
void | |
DEPRECATED: since Creo 4 Displays the solid model note. | |
GetLines () | |
DEPRECATED: since Creo 4 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. | |
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 Get method for attribute "URL" The URL pointed to by the note. | |
void | |
DEPRECATED: since Creo 4 Set method for attribute "Lines" The text of the note. | |
void | SetURL (String value) |
DEPRECATED: since Creo 4 Set method for attribute "URL" The URL pointed to by the note. |
Method Detail
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.
User Guide References:
GetText | ||
GetText | (boolean GiveParametersAsNames) |
Returns the text of the solid model note.
User Guide References:
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 | ||
String | GetURL | () |
SetURL | ||
void | SetURL | (String value) |
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.
User Guide References:
Display | ||
void | Display |
Displays the solid model note.
The model must be present in a window.
User Guide References:
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 | () |
Deletes the solid model note.
Exceptions thrown (but not limited to):
XToolkitCantWrite - Could not delete the given item because it has read-only access.
User Guide References:
Returns:
GetOwner | ||
/*optional*/ ModelItem | GetOwner | () |
Returns the model item that owns the note.
User Guide References:
Returns:
The owner, or null, if the note is not associated with a particular model item.