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

 

RENDER.CALLELEMENT

Invokes an element as defined in the ElementCatalog table.

Syntax

<RENDER.CALLELEMENT
        ELEMENTNAME="nameOfElement"
       [SCOPED="scope value"]


</RENDER.CALLELEMENT>

Attributes

elementname (required)
Input. Name of the element to invoke.
scoped (optional)
Input. Manner in which variables in the calling element are available to the called element, and vice versa. Legal values are local, stacked, global. The default value is local. The following describes the behaviour of the various values:
Variable scoping
Value Description
global

In global scoping, both the calling element and the called element share the same variable pool. As such, all variables present in the caller will be available in the called element, and any changes made to variables in the called element will be visible in the caller afterwards.

Global scope is ideal for calling a utility element to set variables for the caller.

local

In local scoping, the calling element and the called element have independent variable pools. No variables from the caller will be visible to the called element.

Local scope is ideal for calling an element to generate markup.

stacked

In stacked scoping, the calling element and the called element have independent variable pools, but some variables will be copied to the caller after execution of the called element. No variables of the caller will be visible to the called element.

Stacked scoping is a hyrid between global and local scoping. It should be considered an advanced value as global and local will probably be acceptable in most cases.

Description

This tag is equivalent of Sites XML CALLELEMENT tag with the following differences:

This tag should be used whenever an element needs to be invoked on a Sites-enabled site. The element must exist in the ElementCatalog. This tag is preferred over the standard CALLELEMENT tag because it is aware of special variables (rendermode and eid) that Sites elements require. It also offers advanced variable scope handling using the scoped attribute.

Note: There was a bug that the caller variables were available in the callee when the scope is local. This has been fixed in version 11gR1. To go back to the previous behavior add -DuseLegacyLocalScoping=true to JVM parameter.

Error Numbers

The possible values of errno include:

Value
Description
-10
The element does not exist.
-12
The element cannot be evaluated.

Example

The following code sample calls an element named TopPageBreadcrumb.

<RENDER.CALLELEMENT 
      ELEMENTNAME="BurlingtonFinancial/Site/TopPageBreadcrumb">
</RENDER.CALLELEMENT>

See Also

RENDER.CONTENTSERVER