ue_ItemClicking

Description

Occurs when the user clicks an item. This event is analogous to the DataWindow's buttonClicking event that occurs before the buttonClicked event. It is in the ancestor of this event that you would put the code to determine whether or not the clicking of the item is to be allowed.

Argument(s)

Name Script Variable Type Passed By Description
item vs_group String Value Name of the group clicked by the user or the name of the group containing the item clicked by the user
item vs_item String Value Name of the item clicked by the user or empty if the user clicked on a group itself

Return Values

Value Description
ALLOW (1) Indicates that you want to continue processing and fire the ue_itemClicked event
PREVENT (-1) Indicates that you want to stop the further processing of the item's click

Usage

The ue_itemClicked occurs after this event, assuming that the return value from this event is ALLOW (1).

You should, as a rule, check the AncestorReturnValue for this script to make sure the author hasn't added any logic in the ancestor script that would prevent processing.

This event should never be triggered programmatically, instead use of_clickItem, of_clickGroup, of_clickLabel or of_clickLink.

Examples

IF AncestorReturnValue <> ALLOW THEN Return(AncestorReturnValue)

CHOOSE CASE Lower(vs_group)
CASE 'file'
   CHOOSE CASE Lower(vs_item)
   CASE 'save'
      IF parent.Update() = -1 THEN Return(PREVENT)
  END CHOOSE
END CHOOSE

Return(ALLOW)

See Also

Last edited Jun 24, 2016 at 11:46 AM by cjharris02892, version 3