CIP C++ documentation for class "pfcNote"

Class pfcNote

SUCCESSOR(S): pfcDetailNoteItem

# include <pfcNote.h> class pfcNote : public virtual pfcModelItem { xaideclare(pfcNote) ... };

Description

Specifies the information for a solid model note.

Direct Known Subclasses:: wfcWNote

Method Summary


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

`void`	`Display (pfcGraphicsMode Mode)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::Remove, pfcDetailNoteItem::Erase, pfcDetailNoteItem::Show, pfcDetailNoteItem::Draw` Displays the solid model note.

`xstringsequence_ptr`	`GetLines ()`
`void`	`SetLines (xstringsequence_ptr value)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::SetTextLines, pfcDetailNoteItem::GetTextLines` The text of the note.

`optional pfcModelItem_ptr`	`GetOwner ()`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::GetOwner` Returns the model item that owns the note.

`xstringsequence_ptr`	`GetText (xbool GiveParametersAsNames)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::GetTextLines` Returns the text of the solid model note.

`xstring`	`GetURL ()`
`void`	`SetURL (xrstring value)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::SetURL, pfcDetailNoteItem::GetURL` The URL pointed to by the note.

	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::SetTextLines, pfcDetailNoteItem::GetTextLines`

	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::SetURL, pfcDetailNoteItem::GetURL`

Methods Inherited from Class pfcChild:: GetDBParent, GetOId

Methods Inherited from Class pfcActionSource:: AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcRelationOwner:: DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class pfcParent:: GetChild

Methods Inherited from Class pfcParameterOwner:: GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class pfcModelItem:: GetName, SetName, GetId, GetType

Method Detail

`xstringsequence_ptr`	`GetLines`	`()`
`void`	`SetLines`	`(xstringsequence_ptr value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailNoteItem::SetTextLines, pfcDetailNoteItem::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(xbool)

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The note text cannot be varied.

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

xstringsequence_ptr GetText (xbool GiveParametersAsNames)

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailNoteItem::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:

`xstring`	`GetURL`	`()`
`void`	`SetURL`	`(xrstring value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailNoteItem::SetURL, pfcDetailNoteItem::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.

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

void Display (pfcGraphicsMode Mode)

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailNoteItem::Remove, pfcDetailNoteItem::Erase, pfcDetailNoteItem::Show, pfcDetailNoteItem::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:

void Delete ()

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailItem::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.

Manual References:: Solid: Annotations, Solid: Annotations

Returns:

optional pfcModelItem_ptr GetOwner ()

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailNoteItem::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.