Instructions
Methods Introduced:
• pfcDetailNoteItem.SetIsDisplayed
Superseded Methods:
• pfcDetailNoteInstructions.GetTextLines
• pfcDetailNoteInstructions.SetTextLines
• pfcDetailNoteInstructions.GetIsDisplayed
• pfcDetailNoteInstructions.SetIsDisplayed
• pfcDetailNoteInstructions.GetIsReadOnly
• pfcDetailNoteInstructions.SetIsReadOnly
• pfcDetailNoteInstructions.GetIsMirrored
• pfcDetailNoteInstructions.SetIsMirrored
• pfcDetailNoteInstructions.GetHorizontal
• pfcDetailNoteInstructions.SetHorizontal
• pfcDetailNoteInstructions.GetVertical
• pfcDetailNoteInstructions.SetVertical
• pfcDetailNoteInstructions.GetColor
• pfcDetailNoteInstructions.SetColor
• pfcDetailNoteInstructions.GetLeader
• pfcDetailNoteInstructions.SetLeader
• pfcDetailNoteInstructions.GetTextAngle
• pfcDetailNoteInstructions.SetTextAngle
The method pfcDetailNoteInstructions.Create creates a data object that describes how a detail note item should be constructed when passed to the methods pfcDetailItemOwner.CreateDetailItem, pfcDetailSymbolDefItem.CreateDetailItem, or pfcDetailNoteItem.Modify. The parameter inTextLines specifies the sequence of text line data objects that describe the contents of the note.
 |
Changes to the values of a pfcDetailNoteInstructions object do not take effect until that instructions object is used to modify the note using pfcDetailNoteItem.Modify.
For creating a detail note item, the method pfcDetailItemOwner.CreateDetailItem is deprecated, as it uses the deprecated interface pfcDetailNoteInstructions. Use the methods pfcDetailItemOwner.CreateFreeNote, pfcDetailItemOwner.CreateOffsetNote, pfcDetailItemOwner.CreateOnItemNote, or pfcDetailItemOwner.CreateLeaderNote instead.
|
The method pfcDetailNoteItem.GetTextLines returns the description of text line contents in the note.
The method pfcDetailNoteItem.SetTextLines sets the description of the text line contents in the note.
The method pfcDetailNoteItem.IsDisplayed checks if note data is displayed. This is useful for notes whose owner is not displayed in session
The method pfcDetailNoteItem.SetIsDisplayed sets note data displayed. This is useful for notes whose owner is not displayed in session.
The method pfcDetailNoteItem.IsReadOnly determines whether the note can be edited by the user, while the method pfcDetailNoteItem.SetReadOnly toggles the read only status of the note.
The method pfcDetailNoteItem.GetNoteTextStyle and pfcDetailNoteItem.SetNoteTextStyle get and set the textstyle of note.
The methods pfcAnnotationTextStyle.IsTextMirrored checks if the text style is mirrored.
The methods pfcAnnotationTextStyle.MirrorText sets the mirroring of the text style. specifies the option to mirror the text style. Specify the input argument Mirror to true to mirror the text style.
The methods pfcAnnotationTextStyle.GetHorizontalJustification and pfcAnnotationTextStyle.SetHorizontalJustification get and set the horizontal justification of the text style using the enumerated data type pfcHorizontalJustification. The valid values are:
• pfcH_JUSTIFY_LEFT—Aligns the text style object to the left.
• pfcH_JUSTIFY_CENTER—Aligns the text style object in the center.
• pfcH_JUSTIFY_RIGHT—Aligns the text style object to the right.
• pfcH_JUSTIFY_DEFAULT—Aligns the text using the default justification. The justification selected for the first note becomes the default for all successive notes added during the current session.
The methods pfcAnnotationTextStyle.GetVerticalJustification and pfcAnnotationTextStyle.SetVerticalJustification get and set the vertical justification of the text style using the enumerated data type pfcVerticalJustification. The valid values are:
• pfcV_JUSTIFY_TOP—Aligns the text style object to the top.
• pfcV_JUSTIFY_MIDDLE—Aligns the text style object to the middle.
• pfcV_JUSTIFY_BOTTOM—Aligns the text style object to the bottom.
• pfcV_JUSTIFY_DEFAULT—Aligns the text using the default justification. The justification selected for the first note becomes the default for all successive notes added during the current session.
The methods pfcAnnotationTextStyle.GetColor and pfcAnnotationTextStyle.SetColor retrieve and set the color of the text style as a pfcColorRGB object.
The method pfcDetailNoteItem.GetElbowLength returns length of note leader elbow.
The method pfcDetailNoteItem.SetElbow sets elbow to leader note.
The method pfcDetailNoteItem.SetOnItemAttachment sets on item attachment information of note.
The method pfcDetailNoteItem.SetOffsetAttachment sets offset attachment information of note.
The method pfcDetailNoteItem.SetFreeAttachment sets free attachment information of note.
The method pfcDetailNoteItem.GetAttachment returns the attachment information of note.
The methods pfcAnnotationTextStyle.GetAngle and pfcAnnotationTextStyle.SetAngle get and set the angle of the text style.