Instructions
Methods Introduced:
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.DetailNoteInstructions.GetTextLines returns the description of text line contents in the note.
The method pfcDetail.DetailNoteInstructions.SetTextLines sets the description of the text line contents in the note.
The method pfcDetail.DetailNoteInstructions.GetIsDisplayed returns a boolean indicating if the note is currently displayed.
The method pfcDetail.DetailNoteInstructions.SetIsDisplayed sets the display flag for the note.
The method pfcDetail.DetailNoteInstructions.GetIsReadOnly determines whether the note can be edited by the user, while the method pfcDetail.DetailNoteInstructions.SetIsReadOnly toggles the read only status of the note.
The method pfcDetail.DetailNoteInstructions.GetIsMirrored determines whether the note is mirrored, while the method pfcDetail.DetailNoteInstructions.SetIsMirrored toggles the mirrored status of the note.
The method pfcDetail.DetailNoteInstructions.GetHorizontal returns the value of the horizontal justification of the note, while the method pfcDetail.DetailNoteInstructions.SetHorizontal sets the value of the horizontal justification of the note.
The method pfcDetail.DetailNoteInstructions.GetVertical returns the value of the vertical justification of the note, while the method pfcDetail.DetailNoteInstructions.SetVertical sets the value of the vertical justification of the note.
The method pfcDetail.DetailNoteInstructions.GetColor returns the color of the detail note item. The method returns a null value to represent the default drawing color.
Use the method pfcDetail.DetailNoteInstructions.SetColor to set the color of the detail note item. Pass null to use the default drawing color.
The method pfcDetail.DetailNoteInstructions.GetLeader returns the locations of the detail note item and information about the leaders.
The method pfcDetail.DetailNoteInstructions.SetLeader sets the values of the location of the detail note item and the locations where the leaders are attached to the drawing.
The method pfcDetail.DetailNoteInstructions.GetTextAngle returns the value of the angle of the text used in the note. The method returns a null value if the angle is 0.0.
The method pfcDetail.DetailNoteInstructions.SetTextAngle sets the value of the angle of the text used in the note. Pass null to use the angle 0.0.