Home >	Contents >	Index >
Template Tag TOC  |   Alpha TOC  |   Tag Family TOC  |   Purpose TOC  |   Annotated TOC  |   Index

CALLELEMENT

Processes the content of an element.

Syntax

<CALLELEMENT NAME="ELEMENT NAME"   
      [PACKEDARGS="PACKEDARG NAMES"]
      [SCOPED="SCOPING OPTION/>]
      <ARGUMENT NAME="ARG NAME" VALUE="ARG VALUE"/>
</CALLELEMENT>

Parameters

NAME (required)

Name of the element to call.

PACKEDARGS (optional)

A name/value pair to pass to the called element. Pairs are in the format x=y&a=b&c=d. This is useful if a string in this form is retrieved from a database field. It is more efficient to pass individual parameters rather than constructing a string in this form to pass values to an element.

SCOPED (optional)

Valid options for this attribute are as follows:

• GLOBAL - the default behavior
• LOCAL - arguments passed in are restored (or destroyed) on return from the call.
• STACKED - the child only sees the explicit arguments passed in and can only return values in that same namespace.

Description

The CALLELEMENT tag processes the content of an element. The element must exist in the ElementCatalog.

Variables that exist prior to CALLELEMENT are available to tags within the called element. Variables set within the called element are available in the parent element after the CALLELEMENT tag. Variables can also be set using the ARGUMENT tag within the CALLELEMENT tag or by using the PACKEDARGS parameter.

Variables for the CALLELEMENT tag are subject to an order of precedence. The order of precedence is relative to the location of the variable as follows:

1. Variables set in arguments

2. Variables set in scripts

3. resdetails1 and resdetails2 of the ElementCatalog

The following are examples of how the order of precedence works:

• In the following element, the arg=3 variable is set in the resdetails1 column in the ElelementCatalog. The arg value with the highest order of precedence is value1.

  <SETVAR NAME="arg" VALUE="value2"/>
  ...
  <CALLELEMENT NAME="element name">
    <ARGUMENT NAME="arg" VALUE="value1"/>
  </CALLELEMENT>
  

• In the following element, the arg=value3 is set in the redetails1 column in the ElementCatalog. The arg value with the highest order of precedence is value2.

  <SETVAR NAME="arg" VALUE="value2"/>
  ...
  <CALLELEMENT NAME="element name">
  </CALLELEMENT>
  

• In the following element, the arg=value3 is set in the resdetails1 column of the ElementCatalog. The arg value with the highest order of precedence is value3; this is occurs when a variable is not defined in scope before the CALLELEMENT tag.

   <CALLELEMENT NAME="element name">
   </CALLELEMENT>
  

errno

The possible values of errno include:

Value	Description
-10	No element exists.
-12	Cannot evaluate element.

Example

This example calls the element SimpleTest with the arguments Foo and Foo2.

<SETVAR NAME="errno" VALUE="0"/>
<CALLELEMENT NAME="SimpleTest">
   <ARGUMENT NAME="Foo" VALUE="Bar"/>
   <ARGUMENT NAME="Foo2" VALUE="Bar2"/>
</CALLELEMENT>
<IF COND="IsError.Variables.errno=true">
	 	 <THEN>
	 	 <!--Handle error-->
	 	 </THEN>
</IF>

You can specify PACKEDARGS in the following format:

<SETVAR NAME="errno" VALUE="0"/>
<SETVAR NAME="args" VALUE="Foo=Bar&Foo2=Bar2"/>
<CALLELEMENT NAME="SimpleTest"
             PACKEDARGS="Variables.args">
</CALLELEMENT>
<IF COND="IsError.Variables.errno=true">
	 	 <THEN>
	 	 <!--Handle error-->
	 	 </THEN>
</IF>

The parameters Foo and Foo2 with values Bar and Bar2 are available to the element SimpleTest.

See Also

ARGUMENT

		Home >	Contents >	Index >
	FatWire XML Tag Reference Copyright 2005 by FatWire Software All rights reserved.