STK X	Send comments on this topic.
MouseUp Event (AgUiAx2DCntrl)
See Also

Button: Returns an integer that identifies the button that was pressed to cause the event. The Button argument is a bit field with bits corresponding to the left button (bit 0), right button (bit 1), and middle button (bit 2). These bits correspond to the values 1, 2, and 4, respectively. Only one of the bits is set, indicating the button that caused the event.

Shift: An integer that corresponds to the state of the SHIFT, CTRL, and ALT keys at the time of the event. The Shift argument is a bit field with the least-significant bits corresponding to the SHIFT key (bit 0), the CTRL key (bit 1), and the ALT key (bit 2). These bits correspond to the values 1, 2, and 4, respectively. Some, all, or none of the bits can be set, indicating that some, all, or none of the keys are pressed. For example, if both CTRL and ALT are pressed, the value of Shift is 6.

X: Returns a number that specifies the x-position of the current location of the mouse pointer. The x and y values are always expressed in terms of the control window coordinate system.

Y: Returns a number that specifies the y-position of the current location of the mouse pointer. The x and y values are always expressed in terms of the control window coordinate system.

Description

Occur when the user releases a mouse button.

Syntax

[Visual Basic .NET]
Public Event MouseUp( _ ByVal Button As Integer, _ ByVal Shift As Integer, _ ByVal X As Integer, _ ByVal Y As Integer _ )

[Visual Basic .NET]

Public Event MouseUp( _
   ByVal Button As Integer, _
   ByVal Shift As Integer, _
   ByVal X As Integer, _
   ByVal Y As Integer _
)

[C#]
public void MouseUp( int Button, int Shift, int X, int Y );

[C#]

public void MouseUp(

   int Button, 

   int Shift, 

   int X, 

   int Y

);

[Managed C++]
public: void MouseUp( int Button, int Shift, int X, int Y );

[Managed C++]

public: void MouseUp(

   int Button, 

   int Shift, 

   int X, 

   int Y

);

[Java]
public mouseUp( ppInteger Button, ppInteger Shift, int X, int Y );

[Java]

public  mouseUp(

   ppInteger Button, 

   ppInteger Shift, 

   int X, 

   int Y

);

[Unmanaged C++]
public: HRESULT MouseUp( int Button, int Shift, long X, long Y );

[Unmanaged C++]

public: HRESULT MouseUp(

   int Button, 

   int Shift, 

   long X, 

   long Y

);

Parameters

Button: Returns an integer that identifies the button that was pressed to cause the event. The Button argument is a bit field with bits corresponding to the left button (bit 0), right button (bit 1), and middle button (bit 2). These bits correspond to the values 1, 2, and 4, respectively. Only one of the bits is set, indicating the button that caused the event.
Shift: An integer that corresponds to the state of the SHIFT, CTRL, and ALT keys at the time of the event. The Shift argument is a bit field with the least-significant bits corresponding to the SHIFT key (bit 0), the CTRL key (bit 1), and the ALT key (bit 2). These bits correspond to the values 1, 2, and 4, respectively. Some, all, or none of the bits can be set, indicating that some, all, or none of the keys are pressed. For example, if both CTRL and ALT are pressed, the value of Shift is 6.
X: Returns a number that specifies the x-position of the current location of the mouse pointer. The x and y values are always expressed in terms of the control window coordinate system.
Y: Returns a number that specifies the y-position of the current location of the mouse pointer. The x and y values are always expressed in terms of the control window coordinate system.

Remarks

Use a MouseUp event procedure to specify actions that will occur when a given mouse button is released. Unlike the Click and DblClick events, MouseUp events enable you to distinguish between the left, right, and middle mouse buttons. You can also write code for mouse-keyboard combinations that use the SHIFT, CTRL, and ALT keyboard modifiers.

If you need to test for the Button or Shift arguments, you can use the constants available in AgEButtonValues and AgEShiftValues. These constants act as bit masks you can use to test for any combination of buttons without having to figure out the unique bit field value for each combination.

Note You can use a MouseMove event procedure to respond to an event caused by moving the mouse. The Button argument for MouseUp differs from the Button argument used for MouseMove. For MouseUp, the Button argument indicates exactly one button per event, whereas for MouseMove, it indicates the current state of all buttons.

In VB.NET the MouseMove event is shown as "xxxxxxxx_MouseUpEvent" in the IDE.

Description

Syntax

Parameters

Remarks

See Also