Instructions
Methods Introduced:
• pfcDetail.DetailNoteItem.SetIsDisplayed
• pfcDetail.pfcDetailNoteItem.GetNoteTextStyle
• pfcDetail.pfcDetailNoteItem.SetNoteTextStyle
• pfcDetail.DetailNoteItem.IsTextMirrored
• pfcDetail.DetailNoteItem.MirrorText
• pfcDetail.DetailNoteItem.GetHorizontalJustification
• pfcDetail.DetailNoteItem.SetHorizontalJustification
• pfcDetail.DetailNoteItem.GetVerticalJustification
• pfcDetail.DetailNoteItem.SetVerticalJustification
• pfcDetail.DetailNoteItem.GetColor
• pfcDetail.DetailNoteItem.SetColor
• pfcDetail.pfcDetailNoteItem.GetElbowLength
• pfcDetail.pfcDetailNoteItem.SetElbow
• pfcDetail.pfcDetailNoteItem.SetOnItemAttachment
• pfcDetail.pfcDetailNoteItem.SetOffsetAttachment
• pfcDetail.pfcDetailNoteItem.SetFreeAttachment
• pfcDetail.pfcDetailNoteItem.GetAttachment
• pfcDetail.pfcAnnotationTextStyle.GetAngle
• pfcDetail.pfcAnnotationTextStyle.SetAngle
Superseded Methods:
• pfcDetail.pfcDetailNoteInstructions.GetTextLines
• pfcDetail.pfcDetailNoteInstructions.SetTextLines
• pfcDetail.pfcDetailNoteInstructions.GetIsDisplayed
• pfcDetail.pfcDetailNoteInstructions.SetIsDisplayed
• pfcDetail.pfcDetailNoteInstructions.GetIsReadOnly
• pfcDetail.pfcDetailNoteInstructions.SetIsReadOnly
• pfcDetail.pfcDetailNoteInstructions.GetIsMirrored
• pfcDetail.pfcDetailNoteInstructions.SetIsMirrored
• pfcDetail.pfcDetailNoteInstructions.GetHorizontal
• pfcDetail.pfcDetailNoteInstructions.SetHorizontal
• pfcDetail.pfcDetailNoteInstructions.GetVertical
• pfcDetail.pfcDetailNoteInstructions.SetVertical
• pfcDetail.pfcDetailNoteInstructions.GetColor
• pfcDetail.pfcDetailNoteInstructions.SetColor
• pfcDetail.pfcDetailNoteInstructions.GetLeader
• pfcDetail.pfcDetailNoteInstructions.SetLeader
• pfcDetail.pfcDetailNoteInstructions.GetTextAngle
• pfcDetail.pfcDetailNoteInstructions.SetTextAngle
The method pfcDetail.pfcDetail.DetailNoteInstructions_Create creates a data object that describes how a detail note item should be constructed when passed to the methods pfcDetail.DetailItemOwner.CreateDetailItem, pfcDetail.DetailSymbolDefItem.CreateDetailItem, or pfcDetail.DetailNoteItem.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 pfcDetail.DetailNoteInstructions object do not take effect until that instructions object is used to modify the note using pfcDetail.DetailNoteItem.Modify.
For creating a detail note item, the method pfcDetail.DetailItemOwner.CreateDetailItem is deprecated, as it uses the deprecated interface pfcDetail.DetailNoteInstructions. Use the methods pfcDetail.DetailItemOwner.CreateFreeNote, pfcDetail.DetailItemOwner.CreateOffsetNote, pfcDetail.DetailItemOwner.CreateOnItemNote, or pfcDetail.DetailItemOwner.CreateLeaderNote instead.
|
The method pfcDetail.pfcDetailNoteItem.GetTextLines returns the description of text line contents in the note.
The method pfcDetail.pfcDetailNoteItem.SetTextLines sets the description of the text line contents in the note.
The method pfcDetail.pfcDetailNoteItem.IsDisplayed checks if note data is displayed. This is useful for notes whose owner is not displayed in session
The method pfcDetail.pfcDetailNoteItem.SetDisplayed sets note data displayed. This is useful for notes whose owner is not displayed in session.
The method pfcDetail.pfcDetailNoteItem.IsReadOnly determines whether the note can be edited by the user, while the method pfcDetail.pfcDetailNoteItem.SetReadOnly toggles the read only status of the note.
The method pfcDetail.pfcDetailNoteItem.GetNoteTextStyle and pfcDetail.pfcDetailNoteItem.SetNoteTextStyle get and set the text style of note.
The methods pfcDetail.pfcAnnotationTextStyle.IsTextMirrored checks if the text style is mirrored.
The methods pfcDetail.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 pfcDetail.pfcAnnotationTextStyle.GetHorizontalJustification and pfcDetail.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 pfcDetail.pfcAnnotationTextStyle.GetVerticalJustification and pfcDetail.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 pfcDetail.pfcAnnotationTextStyle.GetColor and pfcDetail.pfcAnnotationTextStyle.SetColor retrieve and set the color of the text style as a pfcColorRGB object.
The method pfcDetail.pfcDetailNoteItem.GetElbowLength returns length of note leader elbow.
The method pfcDetail.pfcDetailNoteItem.SetElbow sets elbow to leader note.
The method pfcDetail.pfcDetailNoteItem.SetOnItemAttachment sets on item attachment information of note.
The method pfcDetail.pfcDetailNoteItem.SetOffsetAttachment sets offset attachment information of note.
The method pfcDetail.pfcDetailNoteItem.SetFreeAttachment sets free attachment information of note.
The method pfcDetail.pfcDetailNoteItem.GetAttachment returns the attachment information of note.
The methods pfcDetail.pfcAnnotationTextStyle.GetAngle and pfcDetail.pfcAnnotationTextStyle.SetAngle get and set the angle of the text style.