TCustomAdapterPageProducer.HTMLDoc Property

Specifies the HTML template used to generate the value that the Content method returns.

Pascal

property HTMLDoc: TStrings;

C++

__property TStrings HTMLDoc;

Description

Set HTMLDoc to a set of strings that make up the HTML template. By default, HTMLDoc is initialized to the following template:

Copy Code

<HTML>
<HEAD>
</HEAD>
<BODY>
<#STYLES> <#WARNINGS> <#SERVERSCRIPT>
</BODY>
</HTML>

Each string is a sequence of one or more HTML commands or HTML-transparent tags. An HTML-transparent tag has the form

Copy Code

<#TagName Param1=Value1 Param2=Value2 ...>

A pound sign (#) immediately follows the opening angle bracket (<) with no spaces separating it from the angle bracket. The pound sign identifies the string to the page producer as an HTML-transparent tag. The tag name immediately follows the pound sign with no spaces separating it from the pound sign. Following the tag name, the HTML-transparent tag can optionally include parameters that specify details of the conversion to be performed. Each parameter is of the form ParamName=Value, where there is no space between the parameter name, the equals symbol (=) and the value. Each parameter is delimited by white space.

The angle brackets (< >) make the tag transparent to HTML browsers that do not recognize the #TagName construct.

The page producer converts the entire HTML-transparent tag into true HTML commands based on the value of the tag name. TCustomAdapterPageProducer automatically handles the conversion of the HTML-transparent tags in the default template as follows:

<#STYLES> - This tag is replaced by the stylesheet defined by the Styles or StylesFile property.

<#WARNINGS> - This tag is replaced with design time warnings that indicate possible problems with the hierarchy of web items.

<#SERVERSCRIPT> - This tag is replaced with generated HTML/JavaScript based on the hierarchy of Web items. TCustomAdapterPageProducer will not generate any content if this tag is missing.

If you set HTMLDoc to include other HTML-transparent tags, you must translate these in an OnHTMLTag event handler.

Note: Setting HTMLDoc clears the HTMLFile property.