CIP JavaScript documentation for class " pfcDetailNoteInstructions"

Class pfcDetailNoteInstructions

DEPRECATED: since Creo 4Description

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

Direct Parent Classes:: pfcDetailCreateInstructions

Property Summary


`/* optional */ pfcColorRGB`	`Color`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.GetColor, AnnotationTextStyle.SetColor`
The color of the detail item. If `null`, the default drawing color is used.

`/* optional */ pfcHorizontalJustification`	`Horizontal`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.GetHorizontalJustification, AnnotationTextStyle.SetHorizontalJustification`
The horizontal justification.

`/* optional */ boolean`	`IsDisplayed`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.IsDisplayed`
`true` if the note is currently displayed.

`/* optional */ boolean`	`IsMirrored`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.IsTextMirrored, AnnotationTextStyle.MirrorText`
`true` if the note is mirrored. `null` or `false` if it has normal orientation.

`/* optional */ boolean`	`IsReadOnly`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.SetReadOnly, DetailNoteItem.IsReadOnly`
`true` if the note is readonly. `null` or `false` if it is user editable.

`/* optional */ pfcDetailLeaders`	`Leader`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.GetElbowLength, DetailNoteItem.SetElbow, <reference 1 to unknown entity pfcDetail::DetailNoteItem::SetLeaderAttachment> DetailNoteItem.SetOnItemAttachment, DetailNoteItem.SetOffsetAttachment, DetailNoteItem.SetFreeAttachment, DetailNoteItem.GetAttachment`
The note attachment information, including placement and leaders.

`/* optional */ number`	`TextAngle`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.GetAngle, AnnotationTextStyle.SetAngle`
The text angle used for the note. `null` indicates 0.0.

`pfcDetailTextLines`	`TextLines`

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

`/* optional */ pfcVerticalJustification`	`Vertical`

`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.GetVerticalJustification, AnnotationTextStyle.SetVerticalJustification`
The vertical justification.

Method Summary


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

Property Detail

/* optional */ pfcColorRGB Color


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.GetColor, AnnotationTextStyle.SetColor`
The color of the detail item. If `null`, the default drawing color is used.

/* optional */ pfcHorizontalJustification Horizontal


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.GetHorizontalJustification, AnnotationTextStyle.SetHorizontalJustification`
The horizontal justification.

/* optional */ boolean IsDisplayed


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.IsDisplayed`
`true` if the note is currently displayed.

/* optional */ boolean IsMirrored


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.IsTextMirrored, AnnotationTextStyle.MirrorText`
`true` if the note is mirrored. `null` or `false` if it has normal orientation.

/* optional */ boolean IsReadOnly


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.SetReadOnly, DetailNoteItem.IsReadOnly`
`true` if the note is readonly. `null` or `false` if it is user editable.

/* optional */ pfcDetailLeaders Leader


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.GetElbowLength, DetailNoteItem.SetElbow, <reference 1 to unknown entity pfcDetail::DetailNoteItem::SetLeaderAttachment> DetailNoteItem.SetOnItemAttachment, DetailNoteItem.SetOffsetAttachment, DetailNoteItem.SetFreeAttachment, DetailNoteItem.GetAttachment`
The note attachment information, including placement and leaders. Exceptions thrown (but not limited to): `pfcXToolkitOutOfMemory` - Not enough memory. `pfcXToolkitNotFound` - No leaders were found.

/* optional */ number TextAngle


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.GetAngle, AnnotationTextStyle.SetAngle`
The text angle used for the note. `null` indicates 0.0.

pfcDetailTextLines TextLines


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.SetTextLines, DetailNoteItem.GetTextLines`
Sequence of lines contained in the note. Exceptions thrown (but not limited to): `pfcXToolkitOutOfMemory` - Not enough memory. `pfcXToolkitNotFound` - No text lines were found.

/* optional */ pfcVerticalJustification Vertical


`DEPRECATED: since Creo 4`
`SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.GetVerticalJustification, AnnotationTextStyle.SetVerticalJustification`
The vertical justification.

Method Detail

static pfcDetailNoteInstructions Create (pfcDetailTextLines inTextLines)

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

Parameters:

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

Returns:: The created data object.