Extensibility > Graphics Builder Automation Interface > Miscellaneous Functions > SelectionEventEnabled

SelectionEventEnabled

Writing a true value with this function enables an event to be fired for every selection performed on a graphics page. You can also use this function to retrieve the current setting for this option.

Syntax

SelectionEventEnabled(EventEnabled)

EventEnabled:

Set to TRUE to enable selection events.

Return Value

If retrieving the current setting, TRUE or FALSE. If setting this option, 0 (zero) if successful. In both cases, an error is returned if unsuccessful.

Note: For details on handling return and error values, see Error Handling.

Related Functions

Selection

Note: This function is implemented in the C++ environment as two separate functions: put_SelectionEventEnabled enables or disables this option, and get_SelectionEventEnabled retrieves the current option setting.

Published June 2018