Navigation:  Macros > Macro Language > Built-in Functions > All Functions (Alphabetical) >


Previous pageReturn to chapter overviewNext page

str = FormatText(sTextIn, sParagraphXtags)


This macro function return sTextIn with markers that identify it to be formatted by Q++Studio during diary generation according to the formatting string sFormat. Some important remarks:



This can be any text, even text that is the result of a previous call to the function FormatText (see the section on result, below, for more details). That is to say, formatting can be nested.


Each specifier (see list in table below) is separated from the next by a comma (no space). Any value which can be specified in decimal form must use a period as decimal separator, regardless of the workstation's Windows settings. A sample sFormat would be:


B+,I+,f Times New Roman


The text result of this function will not be formatted text (yet), but rather, plain text with markers that identify it for Q++Studio processing later. For example, the result of a call to the present function may give:


**RICH12**New Year**TEXT12**


Note that you can change the text inside the markers (New Year, in the above example) but the markers themselves should not be changed. If you need to get the plain text, without the markers, you can use the PlainTextOf function.


The list of the various formats supported by this function, and the codes to use are shown below.

Topic 178135 updated on 03-May-2018.
Topic URL: