Rich Text

AddRichText

Description

Appends the contents of a RichText object to the existing contents of another RichText object.

Syntax

rt:AddRichText(rtParam[, bIncPrivate[, bRemBrackets[, bIncSourceCitations]]])

Parameters

rtParam: Rich-Text object: object to append.
bIncPrivate: boolean: optional. Defaults to true if not supplied. Include private notes (text within doubled square brackets - like [[this]]).
bRemBrackets: boolean: optional. Defaults to false if not supplied. If Including private notes, do you want the square brackets to be removed? Ignored if not including private notes..
bIncSourceCitations: boolean: optional. Defaults to true if not supplied. Do you want source citations to be included? Note that this only applies to embedded source citations - that is, to source citations which are embedded in the rich text object. Rich text items (that is, data items that store rich text) can have both embedded and non-embedded source citations. User can add non-embedded source citations to a rich text item in exactly the same way that they can source citations to anything else - in the yellow Citation List pane of the Property Box. Embedded source citations can only be added in the Note Window.

Return Value

none

Remarks

Example

rt = fhNewRichText();
rt:SetText("An <u>important</u> point");
rt2 = fhNewRichText();
rt2:SetText("!!!");
rt:AddRichText(rt2);
sText = rt:GetText();
fhMessageBox(sText); -- displays "An <u>important</u> point!!!"