Home >	Contents >	Index >

Expanded TOC   |    Accordion TOC   |    Annotated TOC   |    Index

ICS.CallElement

Processes the content of an element.

Syntax

public boolean 
CallElement(String element,
            FTVAlList vIn)

Parameters

element

The element name listed in the ElementCatalog table.

vIn

List of name/value pairs to be passed as input parameters to the page. A name/value pair supplied here will overwrite the value of any pre-existing variable of the same name. If vIn is null, the current variable set is used, and may be modified during the page evaluation.

Description

The CallElement method processes the content of an element. The element must exist in the ElementCatalog.

The tag also supports 'custom elements' feature. If there exist a custom element for passed-in 'element' value then Sites will call that custom element instead of original element.
For example, if element 'CustomElements/fatwire/ui/util/ValidateFileUpload' has been implemented as custom implementation then existing element 'fatwire/ui/util/ValidateFileUpload' will not be called when below tag executes -

ics.callelement("fatwire/ui/util/ValidateFileUpload")

For scenario where inspite of having custom element, requirement is to ignore custom element and call original element, use brackets in element name -
ics.callelement("[fatwire/ui/util/ValidateFileUpload]")

Above tag will execute the exact element (fatwire/ui/util/ValidateFileUpload), not the one present inside CustomElements folder.

Note: The method ics.isElement(elementName) does not support bracket in element name.

Returns

Returns true for success and false for failure.

Error Numbers

If an error occurs, errno will be set appropriately. Use GetErrno to view the error.

Example

The following code calls an element named Callee, passing two arguments:

      ics.ClearErrno();
      FTValList args = new FTValList();
      args.removeAll();
      args.setValString("flower", "orange blossom");
      args.setValString("bird", "mockingbird");
      ics.CallElement("Experiment/Callee", args);
      int errs = ics.GetErrno();

 

		Home >	Contents >	Index >
	Oracle JAVA Reference Copyright (c) 2013, 2019, Oracle and/or its affiliates. All rights reserved.