Rich Text

Copy

Description

Copies the contents of another RichText object.

Syntax

bOK = rt:Copy(rtParam[, bIncPrivate[, bRemBrackets[, bIncSourceCitations]]])

Parameters

rtParam: Rich-Text object: object to copy.
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..
bIncSourceCiations: boolean: optional. Defaults to true if not supplied. Include source citations?

Return Value

bOK: boolean: true if successful

Remarks

Example

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