FormGroupControl.mouseDown Method

Article
04/11/2014

Is called when the user presses the mouse button in a form group control.

Syntax

public int mouseDown(
    int x, 
    int y, 
    int button, 
    boolean Ctrl, 
    boolean Shift)

Run On

Client

Parameters

x
Type: int
An integer value that specifies the x-coordinate of the mouse pointer. The coordinate is relative to the upper-left corner of the control.

y
Type: int
An integer value that specifies the y-coordinate of the mouse pointer. The coordinate is relative to the upper-left corner of the control.

button
Type: int
An integer value that specifies which mouse button is down.

Ctrl
Type: boolean
A Boolean value that specifies whether the CTRL key is down.

Shift
Type: boolean
A Boolean value that specifies whether the SHIFT key is down.

Return Value

Type: int
0 (zero) if the event has been handled.

Remarks

Typically, when this method is overridden, the return value from a call to the super method is returned.

The following are the possible values for the button parameter.

1	Left mouse button.
2	Middle mouse button.
3	Right mouse button.

You can override this method in a form group control by right-clicking the Methods node below the control, clicking Override Method, and then clicking mouseDown.

For information about best practices for forms and code, see No Code in Forms.

Share via