ControlEvents Interface Reference

This interface defines the set of common control's events. More...

Inheritance diagram for ControlEvents:


Public Member Functions
	OnClick ([in] IDispatch *Sender)
	This event occurs when the user clicks the control.
	OnDblClick ([in] IDispatch *Sender,[in] LONG x,[in] LONG y,[in] LONG Button,[in] LONG Flags)
	This event occurs when the user double-clicks the left mouse button when the mouse is over the control.
	OnChange ([in] IDispatch *Sender)
	This event occurs when the user changes the some value of the control (this depends of a control).
	OnKeyDown ([in] IDispatch *Sender,[in] LONG Key,[in] LONG Flags)
	This event occurs when the user presses any key while the control has focus.
	OnKeyUp ([in] IDispatch *Sender,[in] LONG Key,[in] LONG Flags)
	This event occurs when the user releases a key that has been pressed.
	OnMouseEnter ([in] IDispatch *Sender)
	This event occurs when the mouse pointer moves over the control.
	OnMouseLeave ([in] IDispatch *Sender)
	This event occurs when the mouse pointer moves off from over the control.
	OnMouseDown ([in] IDispatch *Sender,[in] LONG x,[in] LONG y,[in] LONG Button,[in] LONG Flags)
	This event occurs when the user presses the mouse button while the mouse cursor is in the client area of a control.
	OnMouseMove ([in] IDispatch *Sender,[in] LONG x,[in] LONG y,[in] LONG Flags)
	This event occurs when the mouse pointer moves while it is over the control.
	OnMouseUp ([in] IDispatch *Sender,[in] LONG x,[in] LONG y,[in] LONG Button,[in] LONG Flags)
	This event occurs when the user releases the mouse button while the mouse cursor is in the client area of a control.
	OnResize ([in] IDispatch *Sender)
	This event occurs when the control is resized.
	OnMove ([in] IDispatch *Sender)
	This event occurs when the control is moved.
	OnDestroy ([in] IDispatch *Sender)
	This event occurs when the control is destroyed.
	OnShow ([in] IDispatch *Sender)
	This event occurs when the control is shown.
	OnHide ([in] IDispatch *Sender)
	This event occurs when the control is hidden.
	OnEnabledChange ([in] IDispatch *Sender)
	This event occurs when the control's enabled state changes.
	OnSetFocus ([in] IDispatch *Sender)
	This event occurs when the control has gained the keyboard focus.
	OnKillFocus ([in] IDispatch *Sender)
	This event occurs immediately before the control loses the keyboard focus.
	OnMouseWheel ([in] IDispatch *Sender,[in] LONG Keys,[in] LONG Delta,[in] LONG x,[in] LONG y)
	This event occurs when the user uses mouse wheel and the control has focus.
	OnBeginDock ([in] IDispatch Sender,[in] IDispatch DockTarget,[in] IDispatch *BeginDockContext)
	This event occurs when the user moves a component over drop target.
	OnDockControlCreate ([in] IDispatch Sender,[in] IDispatch Control,[in] IDispatch DockTarget,[in] IDispatch DockControlCreateContext)
	This event occurs when a new parent created automatically for the control.

Detailed Description

This interface defines the set of common control's events.

Member Function Documentation

OnBeginDock	(	[in] IDispatch *	Sender,
		[in] IDispatch *	DockTarget,
		[in] IDispatch *	BeginDockContext
	)

This event occurs when the user moves a component over drop target.

Parameters:

	Sender	The control that raised the event.
	DockTarget	The dock target control.
	BeginDockContext	The dock context, an BeginDockContext object,

See also:: Control::OnBeginDock, Docking Framework.

Since:: 1.1.15.

OnChange ( [in] IDispatch * Sender )

This event occurs when the user changes the some value of the control (this depends of a control).

Parameters:

Sender

The control that raised the event.

OnClick ( [in] IDispatch * Sender )

This event occurs when the user clicks the control.

Parameters:

Sender

The control that raised the event.

OnDblClick	(	[in] IDispatch *	Sender,
		[in] LONG	x,
		[in] LONG	y,
		[in] LONG	Button,
		[in] LONG	Flags
	)

This event occurs when the user double-clicks the left mouse button when the mouse is over the control.

Parameters:

	Sender	The control that raised the event.
	x	The x coordinate of the mouse cursor.
	y	The y coordinate of the mouse cursor.
	Button	The mouse button.

This parameter can be one of the following values:

MK_LBUTTON The Left mouse button is down.
MK_RBUTTON The Right mouse button is down.
MK_MBUTTON The Middle mouse button is down.

Windows 2000/XP:

MK_XBUTTON1 The first X mouse button is down.
MK_XBUTTON2 The second X mouse button is down.

Parameters:

Flags

Indicates whether various keys or buttons are down. This parameter can be a combination of the following values:

MK_LBUTTON The Left mouse button is down.
MK_RBUTTON The Right mouse button is down.
MK_SHIFT The Shift keyboard button is down.
MK_CONTROL The Ctrl keyboard button is down.
MK_MBUTTON The Middle mouse button is down.

Windows 2000/XP:

MK_XBUTTON1 The first X mouse button is down.
MK_XBUTTON2 The second X mouse button is down.

OnDestroy ( [in] IDispatch * Sender )

This event occurs when the control is destroyed.

Parameters:

Sender

The control that raised the event.

OnDockControlCreate	(	[in] IDispatch *	Sender,
		[in] IDispatch *	Control,
		[in] IDispatch *	DockTarget,
		[in] IDispatch *	DockControlCreateContext
	)

This event occurs when a new parent created automatically for the control.

New parent can be created:

By a drag & drop operation.
When the Docking::AlwaysDockTab property changed.
When the Docking::AlwaysDockPage property changed.

Parameters:

	Sender	The control that raised the event.
	Control	The new parent control.
	DockTarget	The dock target control, specified in case of a drag & drop operation, otherwise null.
	DockControlCreateContext	The dock context, an DockControlCreateContext object, specified in case of a drag & drop operation, otherwise null.

See also:: Control::OnBeginDock, Docking::AlwaysDockTab, Docking::AlwaysDockPage, Docking Framework.

Since:: 1.1.15.

OnEnabledChange ( [in] IDispatch * Sender )

This event occurs when the control's enabled state changes.

Parameters:

Sender

The control that raised the event.

OnHide ( [in] IDispatch * Sender )

This event occurs when the control is hidden.

Parameters:

Sender

The control that raised the event.

OnKeyDown	(	[in] IDispatch *	Sender,
		[in] LONG	Key,
		[in] LONG	Flags
	)

This event occurs when the user presses any key while the control has focus.

Parameters:

	Sender	The control that raised the event.
	Key	The virtual key code.
	Flags	This parameter can be a combination of the following values:

KB_SHIFT The Shift (left or right) keyboard button is down.
KB_CTRL The Ctrl (left or right) keyboard button is down.
KB_ALT The Alt (left or right) keyboard button is down.
KB_LSHIFT The left Shift keyboard button is down.
KB_LCTRL The left Ctrl keyboard button is down.
KB_LALT The left Alt keyboard button is down.
KB_RSHIFT The right Shift keyboard button is down.
KB_RCTRL The right Ctrl keyboard button is down.
KB_RALT The right Alt keyboard button is down.

OnKeyUp	(	[in] IDispatch *	Sender,
		[in] LONG	Key,
		[in] LONG	Flags
	)

This event occurs when the user releases a key that has been pressed.

Parameters:

	Sender	The control that raised the event.
	Key	The virtual key code.
	Flags	This parameter can be a combination of the following values:

KB_SHIFT The Shift (left or right) keyboard button is down.
KB_CTRL The Ctrl (left or right) keyboard button is down.
KB_ALT The Alt (left or right) keyboard button is down.
KB_LSHIFT The left Shift keyboard button is down.
KB_LCTRL The left Ctrl keyboard button is down.
KB_LALT The left Alt keyboard button is down.
KB_RSHIFT The right Shift keyboard button is down.
KB_RCTRL The right Ctrl keyboard button is down.
KB_RALT The right Alt keyboard button is down.

OnKillFocus ( [in] IDispatch * Sender )

This event occurs immediately before the control loses the keyboard focus.

Parameters:

Sender

The control that raised the event.

OnMouseDown	(	[in] IDispatch *	Sender,
		[in] LONG	x,
		[in] LONG	y,
		[in] LONG	Button,
		[in] LONG	Flags
	)

This event occurs when the user presses the mouse button while the mouse cursor is in the client area of a control.

Parameters:

	Sender	The control that raised the event.
	x	The x coordinate of the mouse cursor.
	y	The y coordinate of the mouse cursor.
	Button	The mouse button.

This parameter can be one of the following values:

MK_LBUTTON The Left mouse button is down.
MK_RBUTTON The Right mouse button is down.
MK_MBUTTON The Middle mouse button is down.

Windows 2000/XP:

MK_XBUTTON1 The first X mouse button is down.
MK_XBUTTON2 The second X mouse button is down.

Parameters:

Flags

Indicates whether various keys or buttons are down. This parameter can be a combination of the following values:

MK_LBUTTON The Left mouse button is down.
MK_RBUTTON The Right mouse button is down.
MK_SHIFT The Shift keyboard button is down.
MK_CONTROL The Ctrl keyboard button is down.
MK_MBUTTON The Middle mouse button is down.

Windows 2000/XP:

MK_XBUTTON1 The first X mouse button is down.
MK_XBUTTON2 The second X mouse button is down.

OnMouseEnter ( [in] IDispatch * Sender )

This event occurs when the mouse pointer moves over the control.

Parameters:

Sender

The control that raised the event.

OnMouseLeave ( [in] IDispatch * Sender )

This event occurs when the mouse pointer moves off from over the control.

Parameters:

Sender

The control that raised the event.

OnMouseMove	(	[in] IDispatch *	Sender,
		[in] LONG	x,
		[in] LONG	y,
		[in] LONG	Flags
	)

This event occurs when the mouse pointer moves while it is over the control.

Parameters:

	Sender	The control that raised the event.
	x	The x coordinate of the mouse cursor.
	y	The y coordinate of the mouse cursor.
	Flags	Indicates whether various keys or buttons are down. This parameter can be a combination of the following values:

MK_LBUTTON The Left mouse button is down.
MK_RBUTTON The Right mouse button is down.
MK_SHIFT The Shift keyboard button is down.
MK_CONTROL The Ctrl keyboard button is down.
MK_MBUTTON The Middle mouse button is down.

Windows 2000/XP:

MK_XBUTTON1 The first X mouse button is down.
MK_XBUTTON2 The second X mouse button is down.

OnMouseUp	(	[in] IDispatch *	Sender,
		[in] LONG	x,
		[in] LONG	y,
		[in] LONG	Button,
		[in] LONG	Flags
	)

This event occurs when the user releases the mouse button while the mouse cursor is in the client area of a control.

Parameters:

	Sender	The control that raised the event.
	x	The x coordinate of the mouse cursor.
	y	The y coordinate of the mouse cursor.
	Button	The mouse button.

This parameter can be one of the following values:

MK_LBUTTON The Left mouse button is down.
MK_RBUTTON The Right mouse button is down.
MK_MBUTTON The Middle mouse button is down.

Windows 2000/XP:

MK_XBUTTON1 The first X mouse button is down.
MK_XBUTTON2 The second X mouse button is down.

Parameters:

Flags

Indicates whether various keys or buttons are down. This parameter can be a combination of the following values:

MK_LBUTTON The Left mouse button is down.
MK_RBUTTON The Right mouse button is down.
MK_SHIFT The Shift keyboard button is down.
MK_CONTROL The Ctrl keyboard button is down.
MK_MBUTTON The Middle mouse button is down.

Windows 2000/XP:

MK_XBUTTON1 The first X mouse button is down.
MK_XBUTTON2 The second X mouse button is down.

OnMouseWheel	(	[in] IDispatch *	Sender,
		[in] LONG	Keys,
		[in] LONG	Delta,
		[in] LONG	x,
		[in] LONG	y
	)

This event occurs when the user uses mouse wheel and the control has focus.

If the control does not process the OnMouseWheel event, the event propagates from the control to the control's parent.

Some controls, for example ListBox , processes event and the event does not propagates to the control's parent.

If Control::ParentMouseWheel = "TRUE" then the control does not process the event and simply propagates it to the control's parent. A ListBox in this case will skip default event processing.

If Control::StopMouseWheel = "TRUE" then the control does not propagate the event to the control's parent. In this case the control is the last control that processes the event.

Parameters:

	Sender	The control that raised the event.
	Keys	Indicates whether various keys or buttons are down. This parameter can be a combination of the following values:

MK_LBUTTON The Left mouse button is down.
MK_RBUTTON The Right mouse button is down.
MK_SHIFT The Shift keyboard button is down.
MK_CONTROL The Ctrl keyboard button is down.
MK_MBUTTON The Middle mouse button is down.

Windows 2000/XP:

MK_XBUTTON1 The first X mouse button is down.
MK_XBUTTON2 The second X mouse button is down.

Parameters:

Delta

Specifies the distance the wheel is rotated. The Delta is expressed in multiples of 120. The Delta is signed integer (can be <,=, or > 0). Usually Delta = 120 when the wheel is rotated Up, = -120 when the wheel is rotated Down.

For example, a Form displays some list of values. You may calculate Z = Delta / 120. If Z < 0 then scroll the list by Z elements down. If Z > 0 then scroll the list by Z elements up.

Parameters:

	x	The x coordinate of the mouse cursor.
	y	The y coordinate of the mouse cursor.

Since:: 1.1.14.

See also:

See in MSDN:

WM_MOUSEHWHEEL.

OnMove ( [in] IDispatch * Sender )

This event occurs when the control is moved.

Parameters:

Sender

The control that raised the event.

OnResize ( [in] IDispatch * Sender )

This event occurs when the control is resized.

Parameters:

Sender

The control that raised the event.

OnSetFocus ( [in] IDispatch * Sender )

This event occurs when the control has gained the keyboard focus.

Parameters:

Sender

The control that raised the event.

OnShow ( [in] IDispatch * Sender )

This event occurs when the control is shown.

Parameters:

Sender

The control that raised the event.

WSO 1.1 Documentation. Date modified:Wed Aug 12 18:12:28 2015. (C) Veretennikov A. B. 2004-2015

ControlEvents Interface Reference

Public Member Functions

Detailed Description

Member Function Documentation