Detail Note Line Data
Functions Introduced:
The ProDtlnoteline data structure describes the contents of a single line of text in a detail note.
ProDtlnotelineAlloc() and
ProDtlnotelineFree() allocate and free a
ProDtlnoteline structure.
ProDtlnotelineTextAdd() adds a text item, described by a
ProDtlnotetext data structure, to a note line. If the line already contained text items, the new one is added at the end of the array.
ProDtlnotelineTextsSet() sets the contents of a whole text line, by providing a new array of
ProDtlnotetext items. If the note line already contained text items, they are replace by the new ones.
ProDtlnotelineTextsCollect() outputs an array of the text items contained in a specified text line.
Points to note about Text Lines and parameterization:
• If the string in a Text Line you put in a note contains one or more parameters, will divide the Text Line into several Text Items to ensure that each parameter has its own Text Item.
• When you look at the text in an existing note by using the function
ProDtlnoteDataGet() with the
mode option set to
SYMBOLIC (that is, to see the text before substitution of the parameters), you will see the text bracketing and text item identifiers that you also see when you edit a text line in .
For example, if you make a text line containing a single text item with the text
"model = &model_name"
will put the &model_name into a separate text item when the note is created. If you then use
ProDtlnoteDataGet() on the created note with the
mode option set to
SYMBOLIC, you will see the following two text items in the relevant text line
"model = " "&model_name"
If you set mode to NUMERIC, you see these text items:
"model = " "MODEL"
where MODEL is the name of the model.
|
Note:
|
does not resolve and replace symbolic callouts for notes which are not displayed. Therefore, if the note is not displayed or is hidden in a layer, the text retrieved may contain symbolic callouts, even when the mode is set to NUMERIC.
Note that ProDtlnotetextStringGet() does not return the brackets and numbers for each individual text entity. In addition, the function does not return the special escape characters (such as \}) to represent characters previously provided. Refer to the section Creating a Symbol Definition for a description of how to find which model owns the parameter referred to by parameterized text. |