CIP C++ documentation for class "pfcDetailNoteItem"

Class pfcDetailNoteItem

# include <pfcDetail.h> class pfcDetailNoteItem : public virtual pfcDetailItem { xaideclare(pfcDetailNoteItem) ... };

Description

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

See Also:: pfcDetailItemOwner::GetDetailItem(pfcDetailType, xint), pfcDetailItemOwner::ListDetailItems(optional pfcDetailType, optional xint), pfcDetailItemOwner::CreateDetailItem(pfcDetailCreateInstructions_ptr), pfcDetailSymbolDefItem::GetDetailItem(pfcDetailType, xint), pfcDetailSymbolDefItem::ListDetailItems(optional pfcDetailType), pfcDetailSymbolDefItem::CreateDetailItem(pfcDetailCreateInstructions_ptr)

Manual References:: Overview of Creo Object TOOLKIT C++: Casting of Creo Object TOOLKIT C++ pfc Classes to wfc Classes, Drawings: Symbol Instance Data

Direct Known Subclasses:: wfcWDetailNoteItem

Method Summary


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

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

`pfcDetailAttachment_ptr`	`GetAttachment ()`
	Gets attachment information of note.

`optional xreal`	`GetElbowLength ()`
	Gets length of note leader elbow.

`pfcDetailNoteInstructions_ptr`	`GetInstructions (xbool GiveParametersAsNames)`
	Returns a data object describing how a detail note item is constructed.

`pfcEnvelope2D_ptr`	`GetLineEnvelope (xint LineNumber)`
	Returns the envelope of a line in the note, in screen coordinates.

`pfcModel_ptr`	`GetModelReference (xint LineNumber, xint Index)`
	Returns the model referenced by parameterized text in a note.

`optional pfcAnnotationTextStyle_ptr`	`GetNoteTextStyle ()`
	Gets textstyle of note.

`optional pfcModelItem_ptr`	`GetOwner ()`


`optional pfcDetailSymbolDefItem_ptr`	`GetSymbolDef ()`
	The symbol definition that the note belongs to, or `null` if the note does not belong to a symbol definition.

`pfcDetailTextLines_ptr`	`GetTextLines (pfcDetailTextDisplayOption TxtDisplayOption)`


`optional xstring`	`GetURL ()`
	Get URL as part of note text. Availble only for 3D notes

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

`xbool`	`IsReadOnly ()`
	Checks if note is read-only.

`void`	`KeepArrowTypeAsIs (xbool ArrowType)`


`void`	`Modify (pfcDetailNoteInstructions_ptr Instructions)`
	Modifies the definition of an existing detail note item.

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

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

`void`	`SetElbow (optional xreal Length, optional pfcVector3D_ptr Direction)`
	Set elbow to leader note.

`void`	`SetFreeAttachment (pfcFreeAttachment_ptr Attachment)`
	Sets free attachment information of note.

`void`	`SetLeaders (pfcLeaderAttachments_ptr LeaderAttachs)`
	Sets leader attachment information of note.

`void`	`SetNoteTextStyle (pfcAnnotationTextStyle_ptr TextStyle)`
	Sets textstyle of note.

`void`	`SetOffsetAttachment (pfcOffsetAttachment_ptr Attachment)`
	Sets offset attachment information of note.

`void`	`SetOnItemAttachment (pfcParametricAttachment_ptr Attachment)`
	Sets on item attachment information of note.

`void`	`SetReadOnly (xbool ReadOnly)`
	Sets note read-only.

`void`	`SetTextLines (pfcDetailTextLines_ptr TextLines)`


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

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

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

Methods Inherited from Class pfcDetailItem:: GetDetailType, Delete

Method Detail

optional pfcDetailSymbolDefItem_ptr GetSymbolDef ()

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

Manual References:: Drawings: Detail Notes Information, Drawings: Detail Notes Information

void Draw ()

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

The drawing must be current to use this method.

Manual References:: Drawings: Details Notes Operations, Drawings: Details Notes Operations

Returns:

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

Manual References:: Drawings: Details Notes Operations, Drawings: Details Notes Operations

Returns:

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

Manual References:: Drawings: Details Notes Operations, Drawings: Details Notes Operations

Returns:

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

Manual References:: Drawings: Details Notes Operations, Drawings: Details Notes Operations

Returns:

pfcDetailNoteInstructions_ptr GetInstructions (xbool GiveParametersAsNames)

Returns a data object describing how a detail note item is constructed.

Manual References:: Drawings: Detail Notes Information, Drawings: Detail Notes Information

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.

void Modify (pfcDetailNoteInstructions_ptr Instructions)

Modifies the definition of an existing detail note item.

Manual References:: Drawings: Instructions, Drawings: Details Notes Operations

Parameters:

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

Returns:

pfcDetailTextLines_ptr GetTextLines (pfcDetailTextDisplayOption TxtDisplayOption)

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - Not enough memory.

pfcXToolkitNotFound - No text lines were found.

Parameters:

TxtDisplayOption

Returns:

void SetTextLines (pfcDetailTextLines_ptr TextLines)

Exceptions thrown (but not limited to):

pfcXToolkitBadContext - The note text cannot be varied.

pfcXToolkitOutOfMemory - Not enough memory.

Parameters:

TextLines

Returns:

void SetDisplayed (xbool Display)

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

Parameters:

Display

Returns:

xbool IsDisplayed ()

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.

xbool IsReadOnly ()

Checks if note is read-only.

Returns:: xtrue if read only.

void SetReadOnly (xbool ReadOnly)

Sets note read-only.

Parameters:

ReadOnly

Returns:

pfcDetailAttachment_ptr GetAttachment ()

Gets attachment information of note.

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - Not enough memory.

pfcXToolkitNotFound - No leaders were found.

Returns:

void SetFreeAttachment (pfcFreeAttachment_ptr Attachment)

Sets free attachment information of note.

Parameters:

Attachment: free attachment

Returns:

void SetOffsetAttachment (pfcOffsetAttachment_ptr Attachment)

Sets offset attachment information of note.

Parameters:

Attachment: offset attachment

Returns:

void SetOnItemAttachment (pfcParametricAttachment_ptr Attachment)

Sets on item attachment information of note.

Parameters:

Attachment: on item attachment

Returns:

void SetLeaders (pfcLeaderAttachments_ptr LeaderAttachs)

Sets leader attachment information of note.

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - Not enough memory.

Parameters:

LeaderAttachs: leaders

Returns:

void SetElbow (optional xreal Length, optional pfcVector3D_ptr Direction)

Set elbow to leader note.

Parameters:

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

Returns:

optional xreal GetElbowLength ()

Gets length of note leader elbow.

Returns:: length.

optional pfcAnnotationTextStyle_ptr GetNoteTextStyle ()

Gets textstyle of note.

Manual References:: Drawings: Detail Note Data, Drawings: Detail Note Data

Returns:: Textstyle.

void SetNoteTextStyle (pfcAnnotationTextStyle_ptr TextStyle)

Sets textstyle of note.

Manual References:: Drawings: Detail Note Data

Parameters:

TextStyle: Textstyle.

Returns:

pfcEnvelope2D_ptr GetLineEnvelope (xint LineNumber)

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

Exceptions thrown (but not limited to):

pfcXToolkitEmpty - The note is a blank string.

Manual References:: Drawings: Detail Notes Information, Drawings: Detail Notes Information

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.

pfcModel_ptr GetModelReference (xint LineNumber, xint Index)

Returns the model referenced by parameterized text in a note.

Manual References:: Drawings: Detail Notes Information

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.

void SetURL (xrstring URLText)

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

Exceptions thrown (but not limited to):

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

Parameters:

URLText: URL.

Returns:

optional xstring GetURL ()

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

Returns:: URL.

optional pfcModelItem_ptr GetOwner ()

Returns:

void KeepArrowTypeAsIs (xbool ArrowType)

Manual References:: Drawings: Details Notes Operations, Drawings: Details Notes Operations

Parameters:

ArrowType

Returns: