Event Handler Parameters

Use this form to set error messages and other specifications for a form event handler.

This form consists of two sections: The top section is common to all form event response types. The bottom section varies according to the Response > Type that is chosen on the Event Handlers tab of the Details panel.

The top section, common to all form event response types includes these fields and options (all of which are optional):

Field/Option Description
Error Message Enter the message to be displayed when the event handler returns an error. You can include translatable string names and any of the Windows client substitution keywords.
Success Message Enter the message to be displayed when the event handler succeeds. You can include string names and any of the Windows client substitution keywords.
Only When Current Collection Is Select the name of the collection to which this event handler applies.

Normally, event handlers execute regardless of the currently active collection or the specific collection operation that generated the event. Use this option when you want the event to be generated only if the designated collection is the active collection.

Only When Platform Is Select the name of the platform (WIN=Windows, WEB, or ALL) to which this event handler applies.

Normally, event handlers execute regardless of the currently active platform.

KEEP Select the attribute that will be applied to the KEEP parameter of the event handler:
  • FIRST - The event handler appears at the beginning of the event handler list. If there are multiple event handlers with this attribute, they appear in the same order that they appear in the list.
  • LAST - The event handler appears at the end of the event handler list. If there are multiple event handlers with this attribute, they appear in the same order that they appear in the list
  • AFTER - The event handler follows the next NON-KEEP event handler that precedes it.
  • BEFORE- The event handler precedes the next NON-KEEP event handler that follows it.
Ignore Failure Select this option to classify any result returned by this event handler as a success. Use this setting if you want subsequent event handlers to continue to execute even if this event handler returned a failure.

Otherwise, clear this check box. Use this setting if you want the failure of this event handler to stop the execution of subsequent event handlers.

Message on Status Line? Select this option to display the error and success messages in the application’s Status bar.

To have these messages display in a pop-up dialog box, clear this option.

Disabled Select this option to temporarily disable the event handler. Windows client does not run a disabled event handler, even if its other execution criteria are satisfied.

To re-enable the event handler, clear this option.

For the fields and options associated with the various response types, see these topics:

For the Response Type: See this topic:
Add entry to the Audit Log Edit Audit Message Entry
Binary Value Action Event Handler Parameters - Edit Binary Value Action
Collection Copy

Collection Delete

Collection Init with Auto Insert Row

Collection Current

Collection Navigate

Collection New

Collection Notes

Collection Notes for Current

Collection Refresh

Collection Refresh Current

Collection Save

Collection Validate

Event Handler Parameters - Edit Collection Action…
Conditional Action
Execute EXE or other program Edit the Command to Execute
Form Script Method Event Handler Parameters - Edit Script Name and Parameters
Generate Application Event Event Handler Parameters - Edit Generate Application Event Parameters
Generate Event Event Handler Parameters - Edit Event to Generate
Get Location From Browser Event Handler Parameters - Get Location Optional Arguments
Goto Explorer Folder Event Handler Parameters - Edit Goto Explorer Folder
Goto Form Page Select Form Page
Goto Form Event Handler Parameters - Specify Form Run Options
Goto URL Event Handler Parameters - Edit the URL
Inline Script Set Inline Script Language
Invoke User Control This response type is not supported at this time.
Load Collection Event Handler Parameters - Edit Load Collection Parameters
Method Call Event Handler Parameters - Edit Method Call
Print Preview This response type is not supported at this time.
Prompt
Run Background Task Edit Background Task Name and Parameters
Run Form

Run Form as Linked Child

Run Form as Modal Child

Run Form to Retrieve Files

Event Handler Parameters - Specify Form Run Options
Run Script Event Handler Parameters - Edit Script Name and Parameters
Send Web Container Message Event Handler Parameters - Edit Message to Web Container
Set Values Edit Set Values
Timer Event Handler Parameters - Edit Timer Action