Siebel Interactive Designer API Reference > Utility Functions >

RegisterUIElement

Usage

For refresh purposes, use the RegisterUIElement function to inform the application whether a user interface element is an input UI control or an output target.

Pages that do not contain output targets do not usually need to be refreshed after the engine executes. For performance and UI benefits, applications track which pages have only input UI controls, and therefore do not need to be refreshed.

If you write a custom input UI control or target, you must call RegisterUIElement to inform the application whether your custom creation needs to be refreshed.

Syntax

RegisterUIElement(elementName,window,mustRefresh)

Argument
Description
elementName
For input UI controls, the name of the Feature table from which the UI control is built.
For output targets, the name of the Configuration table column, Feature table, or Feature table column for which the target is built.
window
The DOM window object that contains the input UI control or output target.
mustRefresh
Boolean variable used to specify whether elementName is an output target (true = output target, false = input UI control).

See Also

Example 1: Create a Custom Input UI Control

Example 3: Create a Custom Output Target


 Siebel Interactive Designer API Reference 
 Published: 18 April 2003