domObj.xhtmlToRtf

(Merge only) (As of 3.1.001.21)

Return an RTF string that represents the given XHTML string.

Syntax

domObj.xhtmlToRtf([sStr])

Returned Value

RTF representation of the given string.

Parameters

sStr is optional. It defines the string of XHTML text to be converted. Without this parameter, the current value of domObj is used.

Usage

Very rare.

Examples

When domObj is a Field that is currently populated with XHTML markup this script will replace the XHTML with its RTF equivalent.

this._value = this.xhtmlToRtf();

When another object named field1 contains XHTML markup, this script will replace the domObj's value with the RTF equivalent of field1's value.

 this._value = this.xhtmlToRtf(field1._value);

To set the domObj's value to the RTF equivalent of a literal string that contains XHTML markup.

 this._value = this.xhtmlToRtf("Here is some <b>bold</b> text");