Note Properties
Functions Introduced:
The function ProNoteTextGet() returns the text of a 3D model note. The function ProNoteTextSet() modifies the text of an exisitng 3D model note. You can also make symbols to be called out in the 3D notes using the function ProNoteTextSet().
Use the function ProNoteUndisplay() followed by ProNoteDisplay() to update the display status of the note.
The function ProNoteURLGet() retrieves the Uniform Resource Locator (URL) associated with the specified note, whereas ProNoteURLSet() sets the associated URL for the specified note. Specify the note and the URL wide string or the name of the valid combined state as input arguments to the function ProNoteURLWstringSet.
 The functions ProNoteURLGet() and ProNoteURLSet() have been deprecated. Instead, use the functions ProNoteURLWstringGet() and ProNoteURLWstringSet() that return and set, respectively, the Uniform Resource Locator (URL) associated with the specified note as a widestring. |
The function ProNoteURLExtraInfoGet() retrieves the information of whether opening the URL for a specified note appends the extra information "?<model name>+<note id>".
The function ProNoteURLExtraInfoSet() sets whether opening the URL for a specified note should append the extra info "?<model name>+<note id>".
The input argument p_note_item to both the functions is the note for which the extra information needs to be appended.
The function ProNoteOwnerGet() retrieves the owner of the specified note. The owner can be the solid model, a user-chosen feature, or the feature that contains the note's annotation element.
The function ProNoteLeaderstyleGet() returns the leader style used for the note. It can be either standard or ISO. The function ProNoteLeaderstyleSet() sets the leader style of the note.
The function ProNoteElbowlengthGet() returns the elbow properties for the specified note.
The function ProNoteElbowlengthSet() sets the elbow properties of the note. This is equivalent to Move Text option in the Dimension Properties dialog box in .
|
The elbow properties can be retrieved and set for the flat-to-screen notes and the drawing notes. |
The function ProNoteLineEnvelopeGet() returns the envelope of a line for a specified note.
The function ProNoteAttachNormtanleaderGet() returns the properties of a leadered note which is normal/tangent to specified note.
|
adds hard line breaks to the multiple lines drawing notes created in Creo Elements/Pro during retrieval. The hard line breaks display the text of the note on separate lines in the Note Properties dialog box as they actually appear in the drawing note. |
The function ProNoteAttachScreenSet() sets the location of the note text at the screen location. The input arguments follow:
• note_attach—Specifies the handle for ProNoteAttach.
• p1—The parameter in the X direction.
• p2—The parameter in the Y direction.
• p3—The parameter in the Z direction.
The functions ProNoteWrapTextGet() and ProNoteWrapTextSet() get and set the wrap status of the text for a specified note in a solid. The function ProDtlnoteWrapTextSet() sets the text wrapping status to ON or OFF.
The input arguments are listed below:
• note—Specifies the note for which the wrap status is to be set.
• wrap—Specifies if the text is wrapped. To wrap the text specify the value as Pro_B_True.
• wrapwidth—Specifies the width of the wrapped text line, if the input argument wrap is set to Pro_B_True.
The function ProNoteReferencesAdd() adds semantic references to a specified note in a solid. The input arguments are as follows:
• note—Specifies the note to which the additional semantic references are to be added.
• refs—Specifies the array of additional semantic references using the enumerated data type ProAnnotationReference.
|
When a reference includes more than one collection, the function ProNoteReferencesAdd() returns the error PRO_TK_MAX_LIMIT_REACHED and no reference is added. |
The function ProNoteReferencesGet() returns a ProArray of additional semantic references for a note.
The function ProNoteReferenceDelete() deletes the additional semantic references. The input arguments are as follows:
• note —Specifies the note from which the additional semantic references are to be deleted.
• index_ref—Specifies the index references. Indices start from 0.