CIP Visual Basic.NET documentation for interface "IpfcDetailNoteInstructions"

Interface IpfcDetailNoteInstructions

DEPRECATED: since Creo 4Description

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

Direct Parent Classes:: IpfcDetailCreateInstructions

Property Summary


`Property`	`Color`	`as IpfcColorRGB [optional]`

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

`Property`	`Horizontal`	`as IpfcHorizontalJustification [optional]`

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

`Property`	`IsDisplayed`	`as Boolean [optional]`

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

`Property`	`IsMirrored`	`as Boolean [optional]`

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

`Property`	`IsReadOnly`	`as Boolean [optional]`

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

`Property`	`Leader`	`as IpfcDetailLeaders [optional]`

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

`Property`	`TextAngle`	`as Double [optional]`

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

`Property`	`TextLines`	`as IpfcDetailTextLines`

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

`Property`	`Vertical`	`as IpfcVerticalJustification [optional]`

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

Method Summary


`Function`	`CCpfcDetailNoteInstructions.Create (inTextLines as IpfcDetailTextLines) as IpfcDetailNoteInstructions`
	Creates a data object used to describe how a detail note item should be construct, when passed to `IpfcDetailItemOwner.CreateDetailItem()`, `IpfcDetailSymbolDefItem.CreateDetailItem()`, or `IpfcDetailNoteItem.Modify()`.

Property Detail

Property Color as IpfcColorRGB [optional]

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.

Property Horizontal as IpfcHorizontalJustification [optional]

DEPRECATED: since Creo 4

SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.GetHorizontalJustification, AnnotationTextStyle.SetHorizontalJustification

The horizontal justification.

Property IsDisplayed as Boolean [optional]

DEPRECATED: since Creo 4

SUCCESSOR(S): DetailNoteItem.IsDisplayed

true if the note is currently displayed.

Property IsMirrored as Boolean [optional]

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.

Property IsReadOnly as Boolean [optional]

DEPRECATED: since Creo 4

SUCCESSOR(S): DetailNoteItem.SetReadOnly, DetailNoteItem.IsReadOnly

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

Property Leader as IpfcDetailLeaders [optional]

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):

IpfcXToolkitOutOfMemory - Not enough memory.

IpfcXToolkitNotFound - No leaders were found.

Property TextAngle as Double [optional]

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.

Property TextLines as IpfcDetailTextLines

DEPRECATED: since Creo 4

SUCCESSOR(S): DetailNoteItem.SetTextLines, DetailNoteItem.GetTextLines

Sequence of lines contained in the note.

Exceptions thrown (but not limited to):

IpfcXToolkitOutOfMemory - Not enough memory.

IpfcXToolkitNotFound - No text lines were found.

Property Vertical as IpfcVerticalJustification [optional]

DEPRECATED: since Creo 4

SUCCESSOR(S): DetailNoteItem.GetNoteTextStyle, DetailNoteItem.SetNoteTextStyle, AnnotationTextStyle.GetVerticalJustification, AnnotationTextStyle.SetVerticalJustification

The vertical justification.

Method Detail

Function CCpfcDetailNoteInstructions.Create (inTextLines as IpfcDetailTextLines) as IpfcDetailNoteInstructions

Creates a data object used to describe how a detail note item should be construct, when passed to IpfcDetailItemOwner.CreateDetailItem(), IpfcDetailSymbolDefItem.CreateDetailItem(), or IpfcDetailNoteItem.Modify().

Parameters:

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

Returns:: The created data object.