Detail Note Data
Functions Introduced:
The object ProDtlnotedata is an opaque pointer to a data structure that describes the contents of a drawing note.
ProDtlnotedataAlloc() and
ProDtlnotedataFree() allocate and free memory for the data.
ProDtlnotedataIdGet() gives you the integer id of the note in that the data describes. This will be set if the
ProDtlnotedata has been acquired using
ProDtlnoteDataGet(). It is not necessary to set this when creating a note; the function
ProDtlnoteCreate() will assign an id to the new note.
ProDtlnotedataLineAdd() adds a
ProDtlnoteline object to a
ProDtlnotedata description. If the note already contains lines of text, the new line will be added at the end.
ProDtlnoteldataLinesSet() sets an array of
ProDtlnoteline objects as the lines in a
ProDtlnotedata description. If the note already contains text lines, they will be replaced by the new lines.
ProDtlnotedataLinesCollect() outputs an array of
ProDtlnoteline objects describing the lines in a given
ProDtlnotedata description.
ProTextStyleMirrorSet() specifies the option to mirror the note. Specify the input argument
mirror to true to mirror the note.
ProTextStyleMirrorGet() returns the mirroring option specified for the note.
ProTextStyleColorGetWithDef() and
ProTextStyleColorSetWithDef() get and set the color for the note. If you do not call
ProTextStyleColorSetWithDef() when creating a note, the note will have the default color defined by
PRO_COLOR_METHOD_DEFAULT. Refer to the
Draft Entity Data section for a fuller description of the
ProColor object.
ProDtlnotedataAttachmentGet() and
ProDtlnotedataAttachmentSet() get and set the
ProDtlattach object which describes the attachment of the note, that is, where and how it is positioned on the drawing.
ProDtlnotedataLeadersCollect() outputs an array of
ProDtlattach objects which described the attachment points of the leaders on the note.
ProDtlnotedataLeadersSet() adds and array of leaders to a note, replacing existing leaders.
ProDtlnotedataLeaderAdd() adds a new leader to the end of the array of current leaders on a note.
ProDtlnotedataElbowlengthGet() and
ProDtlnotedataElbowlengthSet() get and set the length of the elbow that connects each leader to the note. If you do not call
ProDtlnotedataElbowlengthSet() when creating a note, there will be no elbow.
The functions
ProTextStyleAngleGet() and
PProTextStyleAngleSet() get and set the angle of rotation of the note. If you do not call
ProTextStyleAngleSet() when creating the note, the rotation defaults to 0.0.
The functions
ProTextStyleJustificationGet() and
ProTextStyleJustificationSet() return and set the horizontal justification for the text style object. The functions
ProTextStyleVertJustificationGet() and
ProTextStyleVertJustificationSet() return and set the vertical justification for the text style object. Vertical justification applies only to notes in drawing tables and
OnItem notes.
ProDtlnotedataIsDisplayed() and
ProDtlnotedataDisplayedSet() retrieve and set the flag that controls whether the note is visible or not. If the note is created with this flag set to true, regenerate the drawing using
ProDwgDraftRegenerate() to see the displayed note.
ProDtlnoteDtlsyminstsCollect() returns a list of all the symbol instances that are declared in a detail note via the “sym()” callout format. The symbol instances are returned in the order they are encountered in the note text.
The functions
ProDtlnotedataTextStyleGet() and
ProDtlnotedataTextStyleSet() retrieve and set the text style for the specified note as a
ProTextStyle structure. It takes as input the
ProDtlnotedata object.
If the note has texts with different styles, the style returned by the function
ProDtlnotedataTextStyleGet() will have mixed state for attributes. The attributes are not the same for all texts. In such a case of mixed attribute, if function such as
ProTextStyleFontGet() is called, the error
PRO_TK_GENERAL_ERROR is returned.
The function
ProTextStyleFree() frees the allocated data structure.
The function
ProDtlnoteTableCellGet() returns the information on the rows and columns within a table for the specified table note. The information is given by the following output arguments:
• table—Specifies the table.
• p_row—Specifies the indexed row that starts at 0.
• p_col—Specifies the indexed column that starts at 0.