CIP JAVA documentation for class "com.ptc.pfc.pfcDetail.DetailNoteInstructions"

Interface DetailNoteInstructions

package com.ptc.pfc.pfcDetail; public interface DetailNoteInstructions extends com.ptc.pfc.pfcDetail.DetailCreateInstructions

Description

This interface contains information used to describe a detail note item. It may be used when creating detail notes (DetailItemOwner.CreateDetailItem(DetailCreateInstructions) and DetailSymbolDefItem.CreateDetailItem(DetailCreateInstructions)), or accessing existing notes (DetailNoteItem.Modify(DetailNoteInstructions) and DetailNoteItem.GetInstructions(boolean)).

Method Summary
`/optional/ ColorRGB`	`GetColor ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.GetColor, AnnotationTextStyle.SetColor` Get method for attribute "Color" The color of the detail item. If `null`, the default drawing color is used.
`/optional/ HorizontalJustification`	`GetHorizontal ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.GetHorizontalJustification, AnnotationTextStyle.SetHorizontalJustification` Get method for attribute "Horizontal" The horizontal justification.
`/optional/ Boolean`	`GetIsDisplayed ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.IsDisplayed` Get method for attribute "IsDisplayed" `true` if the note is currently displayed.
`/optional/ Boolean`	`GetIsMirrored ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.IsTextMirrored, AnnotationTextStyle.MirrorText` Get method for attribute "IsMirrored" `true` if the note is mirrored. `null` or `false` if it has normal orientation.
`/optional/ Boolean`	`GetIsReadOnly ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.SetReadOnly, DetailNoteItem.IsReadOnly` Get method for attribute "IsReadOnly" `true` if the note is readonly. `null` or `false` if it is user editable.
`/optional/ DetailLeaders`	`GetLeader ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.GetElbowLength, DetailNoteItem.SetElbow, <reference 1 to unknown entity > DetailNoteItem.SetOnItemAttachment, DetailNoteItem.SetOffsetAttachment, DetailNoteItem.SetFreeAttachment, DetailNoteItem.GetAttachment` Get method for attribute "Leader" The note attachment information, including placement and leaders.
`/optional/ Double`	`GetTextAngle ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.GetAngle, AnnotationTextStyle.SetAngle` Get method for attribute "TextAngle" The text angle used for the note. `null` indicates 0.0.
`DetailTextLines`	`GetTextLines ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.SetTextLines, DetailNoteItem.GetTextLines` Get method for attribute "TextLines" Sequence of lines contained in the note.
`/optional/ VerticalJustification`	`GetVertical ()` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.GetVerticalJustification, AnnotationTextStyle.SetVerticalJustification` Get method for attribute "Vertical" The vertical justification.
`void`	`SetColor ( /optional/ ColorRGB value)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.GetColor, AnnotationTextStyle.SetColor` Set method for attribute "Color" The color of the detail item. If `null`, the default drawing color is used.
`void`	`SetHorizontal ( /optional/ HorizontalJustification value)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.GetHorizontalJustification, AnnotationTextStyle.SetHorizontalJustification` Set method for attribute "Horizontal" The horizontal justification.
`void`	`SetIsDisplayed ( /optional/ Boolean value)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.IsDisplayed` Set method for attribute "IsDisplayed" `true` if the note is currently displayed.
`void`	`SetIsMirrored ( /optional/ Boolean value)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.IsTextMirrored, AnnotationTextStyle.MirrorText` Set method for attribute "IsMirrored" `true` if the note is mirrored. `null` or `false` if it has normal orientation.
`void`	`SetIsReadOnly ( /optional/ Boolean value)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.SetReadOnly, DetailNoteItem.IsReadOnly` Set method for attribute "IsReadOnly" `true` if the note is readonly. `null` or `false` if it is user editable.
`void`	`SetLeader ( /optional/ DetailLeaders value)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.GetElbowLength, DetailNoteItem.SetElbow, <reference 1 to unknown entity > DetailNoteItem.SetOnItemAttachment, DetailNoteItem.SetOffsetAttachment, DetailNoteItem.SetFreeAttachment, DetailNoteItem.GetAttachment` Set method for attribute "Leader" The note attachment information, including placement and leaders.
`void`	`SetTextAngle ( /optional/ Double value)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.GetAngle, AnnotationTextStyle.SetAngle` Set method for attribute "TextAngle" The text angle used for the note. `null` indicates 0.0.
`void`	`SetTextLines (DetailTextLines value)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.SetTextLines, DetailNoteItem.GetTextLines` Set method for attribute "TextLines" Sequence of lines contained in the note.
`void`	`SetVertical ( /optional/ VerticalJustification value)` `DEPRECATED: since Creo 4` `SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.GetVerticalJustification, AnnotationTextStyle.SetVerticalJustification` Set method for attribute "Vertical" The vertical justification.

Methods Inherited from Interface `com.ptc.pfc.pfcDetail.DetailCreateInstructions`
`GetType`, `GetId`

Method Detail

GetTextLines/SetTextLines

`DetailTextLines`	`GetTextLines`	`()`
`void`	`SetTextLines`	`(DetailTextLines value)`

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

Sequence of lines contained in the note.

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - Not enough memory.

XToolkitNotFound - No text lines were found.

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

GetIsDisplayed/SetIsDisplayed

`/optional/ Boolean`	`GetIsDisplayed`	`()`
`void`	`SetIsDisplayed`	`( /optional/ Boolean value)`

DEPRECATED: since Creo 4
SUCCESSOR(S): DetailNoteItem.IsDisplayed

true if the note is currently displayed.

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

GetIsReadOnly/SetIsReadOnly

`/optional/ Boolean`	`GetIsReadOnly`	`()`
`void`	`SetIsReadOnly`	`( /optional/ Boolean value)`

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

GetLeader/SetLeader

`/optional/ DetailLeaders`	`GetLeader`	`()`
`void`	`SetLeader`	`( /optional/ DetailLeaders value)`

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

The note attachment information, including placement and leaders.

Exceptions thrown (but not limited to):

XToolkitOutOfMemory - Not enough memory.

XToolkitNotFound - No leaders were found.

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

GetIsMirrored/SetIsMirrored

`/optional/ Boolean`	`GetIsMirrored`	`()`
`void`	`SetIsMirrored`	`( /optional/ Boolean value)`

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.

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

GetHorizontal/SetHorizontal

`/optional/ HorizontalJustification`	`GetHorizontal`	`()`
`void`	`SetHorizontal`	`( /optional/ HorizontalJustification value)`

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

The horizontal justification.

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

GetVertical/SetVertical

`/optional/ VerticalJustification`	`GetVertical`	`()`
`void`	`SetVertical`	`( /optional/ VerticalJustification value)`

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

The vertical justification.

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

GetColor/SetColor

`/optional/ ColorRGB`	`GetColor`	`()`
`void`	`SetColor`	`( /optional/ ColorRGB value)`

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.

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

GetTextAngle/SetTextAngle

`/optional/ Double`	`GetTextAngle`	`()`
`void`	`SetTextAngle`	`( /optional/ Double value)`

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.

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