ChildTopicsTableHtml

Creates a two column HTML table of child topics. This is a quick way to display all child topics in a page as part of a header topic usually.

For example, to show all DATASTOREDPROC child topics, name the left column Procedure and providing the an abstract of the body and the topic syntax (as an optional last parameter) for the detail.

When used in a topic you can embed the following (all on a single line):

<%=  ChildTopicsTableHtml()  % >

or using the full set of parameters:

<%=  ChildTopicsTableHtml(oHelp,"DATASTOREDPROC",
         "Procedure",
         "oHelp.FormatHtml(oHelp.oTopic.Body)",
         "oHelp.oTopic.Syntax" )  % >

The last two parameters are evaluated expressions.

o.ChildTopicsTableHtml(loHelp,lcChildTypes,lcLeftHeader,lclcDispExp1,lcDispExp2)

Return Value

string

Parameters

loHelp
Reference to a Help Builder Object

lcChildTypes
A comma delimited list of child topics that are to be listed.

lcLeftHeader
The column header label for the left column. The right column always says Description

lcDispExp1
Optional - first display expression. Defaults to the body of the text This content is truncated at the first paragraph.

lcDispExp2
Optional - second display expression displayed underneath the first.

Example

The following can be used in a topic:
-----
This topic tree shows all the stored procedures for Webstore.

<%=  ChildTopicsTableHtml(oHelp,"DATASTOREDPROC","Procedure",
  "oHelp.FormatHtml(oHelp.oTopic.Body)","oHelp.oTopic.Syntax" )% >

See also:

Create a custom child topic view
© West Wind Techologies, 1996-2023 • Updated: 05/24/17
Comment or report problem with topic