peoplecodeapi

SetSearchDialogBehavior

Mon 01 January 2018

Syntax 

SetSearchDialogBehavior(force_or_skip)

Description

Use the SetSearchDialogBehavior function in SearchInit PeopleCode to set the behavior of search and add dialog boxes before a page is displayed, overriding the default behavior. There are two dialog behavior settings: skip if possible (0) and force display (1).

Important! Do not use SetSearchDialogBehavior in fluid applications.

Skip if possible means that the dialog box is skipped if all of the following are true:

  • All required keys have been provided (either by system defaults or by PeopleCode).

  • If this an Add dialog box, then no duplicate key error results from the provided keys; if this error occurs, the processing resets to the default behavior.

  • If this is a Search dialog box, then at least one row is returned based on the provided keys.

Force display means that the dialog box displays even if all required keys have been provided.

The default behavior of the search and add dialog boxes is force display.

Note: SetSearchDialogBehavior can only be used in SearchInit PeopleCode.

Parameters

Field or Control

Definition

force_or_skip

A Number equal to one of the following values:

  • 0: sets the dialog behavior to skip if possible.

  • 1: sets the dialog behavior to force display.

Returns

None.