CIP C++ documentation for class "pfcDetailNoteInstructions"

Class pfcDetailNoteInstructions

# include <pfcDetail.h> class pfcDetailNoteInstructions : public virtual pfcDetailCreateInstructions { xdeclare(pfcDetailNoteInstructions) ... }; This is a COMPACT class.

Description

This interface contains information used to describe a detail note item. It may be used when creating detail notes (pfcDetailItemOwner::CreateDetailItem(pfcDetailCreateInstructions_ptr) and pfcDetailSymbolDefItem::CreateDetailItem(pfcDetailCreateInstructions_ptr)), or accessing existing notes (pfcDetailNoteItem::Modify(pfcDetailNoteInstructions_ptr) and pfcDetailNoteItem::GetInstructions(xbool)).

Manual References:: Drawings: Symbol Instance Data, Drawings: Detail Notes, Drawings: Instructions

Method Summary


`static pfcDetailNoteInstructions_ptr`	`Create (pfcDetailTextLines_ptr inTextLines)`
	Creates a data object used to describe how a detail note item should be construct, when passed to `pfcDetailItemOwner::CreateDetailItem(pfcDetailCreateInstructions_ptr)`, `pfcDetailSymbolDefItem::CreateDetailItem(pfcDetailCreateInstructions_ptr)`, or `pfcDetailNoteItem::Modify(pfcDetailNoteInstructions_ptr)`.

`optional pfcColorRGB_ptr`	`GetColor ()`
`void`	`SetColor (optional pfcColorRGB_ptr value)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::GetNoteTextStyle, pfcDetailNoteItem::SetNoteTextStyle, pfcAnnotationTextStyle::GetColor, pfcAnnotationTextStyle::SetColor` The color of the detail item. If `null`, the default drawing color is used.

`optional pfcHorizontalJustification`	`GetHorizontal ()`
`void`	`SetHorizontal (optional pfcHorizontalJustification value)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::GetNoteTextStyle, pfcDetailNoteItem::SetNoteTextStyle, pfcAnnotationTextStyle::GetHorizontalJustification, pfcAnnotationTextStyle::SetHorizontalJustification` The horizontal justification.

`optional xbool`	`GetIsDisplayed ()`
`void`	`SetIsDisplayed (optional xbool value)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::IsDisplayed` `true` if the note is currently displayed.

`optional xbool`	`GetIsMirrored ()`
`void`	`SetIsMirrored (optional xbool value)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::GetNoteTextStyle, pfcDetailNoteItem::SetNoteTextStyle, pfcAnnotationTextStyle::IsTextMirrored, pfcAnnotationTextStyle::MirrorText` `true` if the note is mirrored. `null` or `false` if it has normal orientation.

`optional xbool`	`GetIsReadOnly ()`
`void`	`SetIsReadOnly (optional xbool value)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::SetReadOnly, pfcDetailNoteItem::IsReadOnly` `true` if the note is readonly. `null` or `false` if it is user editable.

`optional pfcDetailLeaders_ptr`	`GetLeader ()`
`void`	`SetLeader (optional pfcDetailLeaders_ptr value)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::GetElbowLength, pfcDetailNoteItem::SetElbow, <reference 3 to unknown entity > pfcDetailNoteItem::SetOnItemAttachment, pfcDetailNoteItem::SetOffsetAttachment, pfcDetailNoteItem::SetFreeAttachment, pfcDetailNoteItem::GetAttachment` The note attachment information, including placement and leaders.

`optional xreal`	`GetTextAngle ()`
`void`	`SetTextAngle (optional xreal value)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::GetNoteTextStyle, pfcDetailNoteItem::SetNoteTextStyle, pfcAnnotationTextStyle::GetAngle, pfcAnnotationTextStyle::SetAngle` The text angle used for the note. `null` indicates 0.0.

`pfcDetailTextLines_ptr`	`GetTextLines ()`
`void`	`SetTextLines (pfcDetailTextLines_ptr value)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::SetTextLines, pfcDetailNoteItem::GetTextLines` Sequence of lines contained in the note.

`optional pfcVerticalJustification`	`GetVertical ()`
`void`	`SetVertical (optional pfcVerticalJustification value)`
	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::GetNoteTextStyle, pfcDetailNoteItem::SetNoteTextStyle, pfcAnnotationTextStyle::GetVerticalJustification, pfcAnnotationTextStyle::SetVerticalJustification` The vertical justification.

	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::GetNoteTextStyle, pfcDetailNoteItem::SetNoteTextStyle, pfcAnnotationTextStyle::GetColor, pfcAnnotationTextStyle::SetColor`

	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::GetNoteTextStyle, pfcDetailNoteItem::SetNoteTextStyle, pfcAnnotationTextStyle::GetHorizontalJustification, pfcAnnotationTextStyle::SetHorizontalJustification`

	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::IsDisplayed`

	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::GetNoteTextStyle, pfcDetailNoteItem::SetNoteTextStyle, pfcAnnotationTextStyle::IsTextMirrored, pfcAnnotationTextStyle::MirrorText`

	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::SetReadOnly, pfcDetailNoteItem::IsReadOnly`

	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::GetElbowLength, pfcDetailNoteItem::SetElbow, <reference 3 to unknown entity > pfcDetailNoteItem::SetOnItemAttachment, pfcDetailNoteItem::SetOffsetAttachment, pfcDetailNoteItem::SetFreeAttachment, pfcDetailNoteItem::GetAttachment`

	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::GetNoteTextStyle, pfcDetailNoteItem::SetNoteTextStyle, pfcAnnotationTextStyle::GetAngle, pfcAnnotationTextStyle::SetAngle`

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

	`DEPRECATED: since Creo 4` `SUCCESSOR(S): pfcDetailNoteItem::GetNoteTextStyle, pfcDetailNoteItem::SetNoteTextStyle, pfcAnnotationTextStyle::GetVerticalJustification, pfcAnnotationTextStyle::SetVerticalJustification`

Methods Inherited from Class pfcDetailCreateInstructions:: GetType, GetId

Method Detail

`pfcDetailTextLines_ptr`	`GetTextLines`	`()`
`void`	`SetTextLines`	`(pfcDetailTextLines_ptr value)`

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

Sequence of lines contained in the note.

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - Not enough memory.

pfcXToolkitNotFound - No text lines were found.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

`optional xbool`	`GetIsDisplayed`	`()`
`void`	`SetIsDisplayed`	`(optional xbool value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailNoteItem::IsDisplayed

true if the note is currently displayed.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

`optional xbool`	`GetIsReadOnly`	`()`
`void`	`SetIsReadOnly`	`(optional xbool value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailNoteItem::SetReadOnly, pfcDetailNoteItem::IsReadOnly

true if the note is readonly. null or false if it is user editable.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

`optional pfcDetailLeaders_ptr`	`GetLeader`	`()`
`void`	`SetLeader`	`(optional pfcDetailLeaders_ptr value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailNoteItem::GetElbowLength, pfcDetailNoteItem::SetElbow, <reference 3 to unknown entity > pfcDetailNoteItem::SetOnItemAttachment, pfcDetailNoteItem::SetOffsetAttachment, pfcDetailNoteItem::SetFreeAttachment, pfcDetailNoteItem::GetAttachment

The note attachment information, including placement and leaders.

Exceptions thrown (but not limited to):

pfcXToolkitOutOfMemory - Not enough memory.

pfcXToolkitNotFound - No leaders were found.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

static pfcDetailNoteInstructions_ptr Create (pfcDetailTextLines_ptr inTextLines)

Creates a data object used to describe how a detail note item should be construct, when passed to pfcDetailItemOwner::CreateDetailItem(pfcDetailCreateInstructions_ptr), pfcDetailSymbolDefItem::CreateDetailItem(pfcDetailCreateInstructions_ptr), or pfcDetailNoteItem::Modify(pfcDetailNoteInstructions_ptr).

Manual References:: Drawings: Instructions, Drawings: Instructions

Parameters:

inTextLines: Sequence of text line data objects describing the contents of the note.

Returns:: The created data object.

`optional xbool`	`GetIsMirrored`	`()`
`void`	`SetIsMirrored`	`(optional xbool value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailNoteItem::GetNoteTextStyle, pfcDetailNoteItem::SetNoteTextStyle, pfcAnnotationTextStyle::IsTextMirrored, pfcAnnotationTextStyle::MirrorText

true if the note is mirrored. null or false if it has normal orientation.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

`optional pfcHorizontalJustification`	`GetHorizontal`	`()`
`void`	`SetHorizontal`	`(optional pfcHorizontalJustification value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailNoteItem::GetNoteTextStyle, pfcDetailNoteItem::SetNoteTextStyle, pfcAnnotationTextStyle::GetHorizontalJustification, pfcAnnotationTextStyle::SetHorizontalJustification

The horizontal justification.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

`optional pfcVerticalJustification`	`GetVertical`	`()`
`void`	`SetVertical`	`(optional pfcVerticalJustification value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailNoteItem::GetNoteTextStyle, pfcDetailNoteItem::SetNoteTextStyle, pfcAnnotationTextStyle::GetVerticalJustification, pfcAnnotationTextStyle::SetVerticalJustification

The vertical justification.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

`optional pfcColorRGB_ptr`	`GetColor`	`()`
`void`	`SetColor`	`(optional pfcColorRGB_ptr value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailNoteItem::GetNoteTextStyle, pfcDetailNoteItem::SetNoteTextStyle, pfcAnnotationTextStyle::GetColor, pfcAnnotationTextStyle::SetColor

The color of the detail item. If null, the default drawing color is used.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions, Drawings: Instructions

`optional xreal`	`GetTextAngle`	`()`
`void`	`SetTextAngle`	`(optional xreal value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): pfcDetailNoteItem::GetNoteTextStyle, pfcDetailNoteItem::SetNoteTextStyle, pfcAnnotationTextStyle::GetAngle, pfcAnnotationTextStyle::SetAngle

The text angle used for the note. null indicates 0.0.

Manual References:: Drawings: Instructions, Drawings: Instructions, Drawings: Instructions