WrapHTML Method

Syntax

C1QueryFrame.WrapHtml(Text, Item, LineBreak)

Notes

Method applies to C1QueryFrame control.

Arguments

Text is an HTML text generated from a query item, usually produced by the GenerateHTML method.

Item is a QueryItem object defining the item context. The Item argument is always the same object passed to C1QRender() script as its argument. Passing the Item argument to this method, use item navigation methods to position the Item object, see Accessing and Modifying Query Items.

LineBreak is a Boolean argument specifying whether the resulting HTML starts a new line. If LineBreak=True, a <DIV> tag is used to enclose the HTML text, otherwise, a <SPAN> tag is used.

Return Value

HTML text representing an item, enclosed in <DIV> or <SPAN> tags according to the rules required by C1QueryFrame scripts, complete with special id and style.

Description

This method is used exclusively in C1QRender() scripts, see Customizing the UI with Scripts.

You must use this method to ensure that your HTML text representing an item follows the rules required by C1QueryFrame. Calling this method encloses the item in <DIV> or <SPAN>, complete with special id and style required by C1QueryFrame.

Usually, this method is called immediately after calling GenerateHTML.