FormRichTextControl.mouseDown Method

Is called when the user clicks the mouse button over the control.

Syntax

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

Run On

Client

Parameters

  • x
    Type: int
    The x-coordinate of the mouse pointer. The coordinate is relative to the upper-left corner of the control.
  • y
    Type: int
    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: 1 if the left mouse button is down, 2 if the middle mouse button is down, or 3 if the right mouse button is down.
  • Ctrl
    Type: boolean
    A Boolean value that indicates whether the CTRL key is down.
  • Shift
    Type: boolean
    A Boolean value that indicates 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.

This event is called only if a value is specified for the label of the control and the ShowLabel property of the control is set to Yes.

See Also

Reference

FormRichTextControl Class