$.udb.cancelWindow()

note

This article is about the cancelWindow() function of the udb object.

$.udb.cancelWindow()

Rejects the lookup value and close the lookup page or dialog.

Returns a Promise object or the 'this' object. From USoft 10.0.1I, returns a udbPromise instead of a Promise object.

Syntax

.cancelWindow( *options* )

*options*  ::=  {
    promise:  *promise*,
    success:  *success-function*,
    error:  *error-function*
}

*promise*  ::=  { true | false }

Options is a struct that can have the following items, all of which are optional.

*Promise *determines the return value of this function. If promise has the value 'true' (the default), a Promise object is returned. If promise has the value 'false', the ‘this’ object is returned instead.

Success-function is a function called after the operation has successfully completed.

Error-function is a function called if an error occurs.

Example

$.udb.cancelWindow();

tip

This function is called by default on the Cancel button of the default lookup pages.