ESP Directives › Built-In Functions › ESPList

ESPList

This function strings together the identified elements of an array into a single string with the specified string between each element.

Syntax

This function uses the following syntax:

<% set var=variable function=ESPList 
parm1=separator 
{ parm2=mdoPrefix.{*}.mdoSuffix | 
   parm3=stemPrefix.*.stemSuffix |
   parm4=varPrefix } 
[ parm5=fromRange ] [ parm6=toRange ] 
[parm7=quoting  [parm8=quoteScope] ] [ parm9=REVERSE ]  %>

Parameters

This function contains the following parameters:

• parm1=separator

  String to place between elements of the list.

• parm2=mdoPrefix.{*}.mdoSuffix

  Indicates that the variable source is an MDO. The MDO is assumed to have the structure: mdoPrefix.{*}.mdoSuffix.

  Each item (mdoSuffix) of the list mdoPrefix.{*} is strung together with the separator between each item.

• parm3=stemPrefix.*.stemSuffix

  Indicates that the variable source is an OML stem. The stem is assumed to have the following structure:

  • stemPrefix.0—number of items in structure
  • stemPrefix.1.stemSuffix—first item in list
  • stemPrefix.2.stemSuffix—second item …

    Each item of the list is strung together with the separator between each item.

• parm4=varPrefix

  Indicates that the variable source is a variable prefix. The array structure is assumed to be of the form:

  • varPrefix1—first item
  • varPrefix2—second item …

    Each item of the array is strung together with the separator between each item. The list is assumed to terminate at the first null variable reference.

• parm5=fromRange

  Starting item of the list. Default is 1.

• parm6=toRange

  Ending item of the list. If not specified, then the whole list is assumed. Null elements of the list result in consecutive separators.

• parm7=quoting

  Allows the specification of particular quoting for each item of the list. If not specified, then no quoting is done. The valid quoting options are:

  • HTMLQuote— Quote the item for HTML.
  • JSQuote—Quote the item for JavaScript.
• parm8=quoteScope

  This parameter is only valid when quoting is specified. It indicates the scope of the quoting. Specify one of the following:

  • ITEM—Quoting is only done for the list items.
  • SEP—Quoting is only done for the item separator.
  • ALL—Quoting is done for both item and separator.
• parm9=REVERSE

  If specified, then tells ESPList to process the items in reverse order.

Returns

String.

Examples

[assign the value for TD in your book]<%=ESPList parm1='</td>[assign the value for TD in your book]'  parm4=$SLRID %> </td>

results in:

[assign the value for TD in your book]first item</td>[assign the value for TD in your book]second item</td>third item</td>