IsModalComponent function

Syntax

IsModalComponent()

Description

Use the IsModalComponent function to test whether a secondary component is currently executing, enabling you to write PeopleCode that only executes when a component has been called with DoModalComponent.

Parameters

None.

Returns

Returns a Boolean value: True if the current program is executing from a secondary component, False otherwise.

Example

If IsModalComponent() then
/* Logic that executes only if component is executing modally.  */
end-if;

Restrictions on Use With a Component Interface

This function is ignored (has no effect) when used by a PeopleCode program that’s been called by a Component Interface.