Method XbpActiveXControl():click() Foundation

Default event handler for ActiveX control event "Click" (DISPID_CLICK).

:click() --> self

This method returns the object executing the method (self).


The method :click() is called automatically upon reception of a "Click" (DISPID_CLICK) COM event. The :click() event handler determines the mouse button pressed and generates an xbeM_LbClick, xbeM_RbClick or xbeM_MbClick event. The event is posted to the current thread's message queue using the function PostAppEvent().

Applications can process mouse events via the standard event protocol defined for Xbase Parts. In order to react to mouse events generated by an ActiveX control, a code block can be assigned to one of the callback slots :lbClick, :rbClick or :mbClick, respectively. Alternatively, an overloaded method :lbClick(), :rbClick()or :mbClick() can be implemented in a derived class.

Not all ActiveX controls generate mouse events. If a control does not generate "Click" (DISPID_CLICK) events, the method :click() will not be called.


If you see anything in the documentation that is not correct, does not match your experience with the particular feature or requires further clarification, please use this form to report a documentation issue.