Rich Text

SetText

Description

Sets the contents of a RichText object with a string that can be in eFTF syntax or tFTF syntax. The existing text contents are replaced when you call this function. Citations cannot be added using this function - use the AddCitation method instead. Record links can be added, but only if you set both bRich and bTFTF to true, and supply the record links using tFTF syntax.

Syntax

rt:SetText(strText[, bRich[, bTFTF]])

Parameters

strText: string in eFtf syntax: text to set.

bIsRich: boolean: Optional. Defaults to true. If true, strText contains rich text in either eFTF syntax (if bTFTF is not supplied or false) or in tFTF syntax (if bTFTF is supplied and true). Otherwise, strText is treated as plain text.

bTFTF: boolean: Optional. Defaults to false. Ignored if bIsRich is false. If true, and if bIsRich is true, strText contains rich text in tFTF syntax.

Return Value

none

Remarks

Example

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