The TextBox class' events interface More...

Public Member Functions
void	TextChanged (void)
	The control's text was changed More...

void	AbortedDrag (void)
	A drag'n'drop operation was aborted More...

void	BeforeDrawText (void)
	The control's text is about to be drawn More...

void	BeginDrag (LONG firstChar, LONG lastChar, SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	The user seems to want to drag text More...

void	BeginRDrag (LONG firstChar, LONG lastChar, SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	The user seems to want to drag text More...

void	Click (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	The user clicked into the control's client area More...

void	ContextMenu (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y, VARIANT_BOOL *showDefaultMenu)
	The context menu should be displayed More...

void	DblClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	The user double-clicked into the control's client area More...

void	DestroyedControlWindow (LONG hWnd)
	The control window was destroyed More...

void	DragMouseMove (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y, LONG autoHScrollVelocity, LONG autoVScrollVelocity)
	The mouse cursor was moved over the control's client area More...

void	Drop (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	A drag'n'drop operation ended successful More...

void	KeyDown (SHORT *keyCode, SHORT shift)
	A key was pressed while the control has the focus More...

void	KeyPress (SHORT *keyAscii)
	An alphanumeric key was pressed and released while the control has the focus More...

void	KeyUp (SHORT *keyCode, SHORT shift)
	A key was released while the control has the focus More...

void	MClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	The user clicked into the control's client area More...

void	MDblClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	The user double-clicked into the control's client area More...

void	MouseDown (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	A mouse button was pressed over the control's client area More...

void	MouseEnter (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	The mouse cursor was moved into the control's client area More...

void	MouseHover (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	The mouse cursor was moved into the control's client area a specified period of time before More...

void	MouseLeave (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	The mouse cursor was moved out of the control's client area More...

void	MouseMove (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	The mouse cursor was moved over the control's client area More...

void	MouseUp (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	A mouse button was released over the control's client area More...

void	MouseWheel (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y, ScrollAxisConstants scrollAxis, SHORT wheelDelta)
	The mouse wheel was rotated over the control's client area More...

void	OLECompleteDrag (IOLEDataObject *data, OLEDropEffectConstants performedEffect)
	An OLE drag'n'drop operation was completed More...

void	OLEDragDrop (IOLEDataObject data, OLEDropEffectConstants effect, SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	The data was dropped onto the control during OLE drag'n'drop More...

void	OLEDragEnter (IOLEDataObject data, OLEDropEffectConstants effect, SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y, LONG autoHScrollVelocity, LONG autoVScrollVelocity)
	The data was dragged into the control during OLE drag'n'drop More...

void	OLEDragEnterPotentialTarget (LONG hWndPotentialTarget)
	The user has dragged the data into a potential drop target window during OLE drag'n'drop More...

void	OLEDragLeave (IOLEDataObject *data, SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	The data was dragged out of the control during OLE drag'n'drop More...

void	OLEDragLeavePotentialTarget (void)
	The user has dragged the data out of a potential drop target window during OLE drag'n'drop More...

void	OLEDragMouseMove (IOLEDataObject data, OLEDropEffectConstants effect, SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y, LONG autoHScrollVelocity, LONG autoVScrollVelocity)
	The data was dragged over the control during OLE drag'n'drop More...

void	OLEGiveFeedback (OLEDropEffectConstants effect, VARIANT_BOOL *useDefaultCursors)
	The mouse cursor needs to be updated during OLE drag'n'drop More...

void	OLEQueryContinueDrag (VARIANT_BOOL pressedEscape, SHORT button, SHORT shift, OLEActionToContinueWithConstants *actionToContinueWith)
	The drag source should decide how to proceed with the OLE drag'n'drop operation More...

void	OLEReceivedNewData (IOLEDataObject *data, LONG formatID, LONG Index, LONG dataOrViewAspect)
	Data has been stored in the data object More...

void	OLESetData (IOLEDataObject *data, LONG formatID, LONG Index, LONG dataOrViewAspect)
	Data is requested from the data object More...

void	OLEStartDrag (IOLEDataObject *data)
	The container holding the dragged data needs to be filled up More...

void	OutOfMemory (void)
	The control couldn't allocate enough memory More...

void	RClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	The user clicked into the control's client area More...

void	RDblClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	The user double-clicked into the control's client area More...

void	RecreatedControlWindow (LONG hWnd)
	The control window was recreated More...

void	ResizedControlWindow (void)
	The control window was resized More...

void	Scrolling (ScrollAxisConstants axis)
	The control is being scrolled More...

void	TruncatedText (void)
	The text, that was entered into the control, got truncated More...

void	WritingDirectionChanged (WritingDirectionConstants newWritingDirection)
	The control's writing direction has been changed by the user More...

void	XClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	The user clicked into the control's client area More...

void	XDblClick (SHORT button, SHORT shift, OLE_XPOS_PIXELS x, OLE_YPOS_PIXELS y)
	The user double-clicked into the control's client area More...

Detailed Description

The TextBox class' events interface

Author: Timo "TimoSoft" Kunze This interface defines all events the TextBox class may raise.

See also: ITextBox

Member Function Documentation

◆ TextChanged()

void TextChanged ( void )

The control's text was changed

Will be fired after the control's content was changed.

Remarks: This is the control's default event.
This event may be disabled.

See also: ITextBox::Text

◆ AbortedDrag()

void AbortedDrag ( void )

A drag'n'drop operation was aborted

Will be fired if a drag'n'drop operation was aborted.

See also: Drop, ITextBox::EndDrag

◆ BeforeDrawText()

void BeforeDrawText ( void )

The control's text is about to be drawn

Will be fired before the control's content is drawn. This makes it possible to resize the control, if necessary.

Remarks: This event may be disabled.

See also: ITextBox::Text, ITextBox::DisabledEvents

◆ BeginDrag()

void BeginDrag	(	LONG	firstChar,
		LONG	lastChar,
		SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

The user seems to want to drag text

Will be fired if the user seems to want to drag text using the left mouse button.

Parameters

[in]	firstChar	The zero-based index of the first character of the text that the user wants to drag.
[in]	lastChar	The zero-based index of the last character of the text that the user wants to drag.
[in]	button	The pressed mouse buttons. Any combination of the values defined by VB's `MouseButtonConstants` enumeration is valid, but usually it is just `vbLeftButton`.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.

See also: ITextBox::BeginDrag, ITextBox::OLEDrag, ITextBox::AllowDragDrop, BeginRDrag

◆ BeginRDrag()

void BeginRDrag	(	LONG	firstChar,
		LONG	lastChar,
		SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

The user seems to want to drag text

Will be fired if the user seems to want to drag text using the right mouse button.

Parameters

[in]	firstChar	The zero-based index of the first character of the text that the user wants to drag.
[in]	lastChar	The zero-based index of the last character of the text that the user wants to drag.
[in]	button	The pressed mouse buttons. Any combination of the values defined by VB's `MouseButtonConstants` enumeration is valid, but usually it is just `vbRightButton`.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.

See also: ITextBox::BeginDrag, ITextBox::OLEDrag, ITextBox::AllowDragDrop, BeginDrag

◆ Click()

void Click	(	SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

The user clicked into the control's client area

Will be fired if the user clicks into the control's client area using the left mouse button.

Parameters

[in]	button	The mouse buttons that were pressed during the click. This should always be `vbLeftButton` (defined by VB's `MouseButtonConstants` enumeration).
[in]	shift	The modifier keys (Shift, Ctrl, Alt) that were pressed during the click. Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the click's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the click's position relative to the control's upper-left corner.

Remarks: This event may be disabled.

See also: DblClick, MClick, RClick, XClick, ITextBox::DisabledEvents

◆ ContextMenu()

void ContextMenu	(	SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y,
		VARIANT_BOOL *	showDefaultMenu
	)

The context menu should be displayed

Will be fired if the control's context menu should be displayed.

Parameters

[in]	button	The pressed mouse buttons. Any combination of the values defined by VB's `MouseButtonConstants` enumeration is valid.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the menu's proposed position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the menu's proposed position relative to the control's upper-left corner.
[in,out]	showDefaultMenu	If set to `True`, the default context menu is displayed; otherwise the control doesn't display any context menu itself, but you may display your custom menu.

See also: RClick

◆ DblClick()

void DblClick	(	SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

The user double-clicked into the control's client area

Will be fired if the user double-clicks into the control's client area using the left mouse button.

Parameters

[in]	button	The mouse buttons that were pressed during the double-click. This should always be `vbLeftButton` (defined by VB's `MouseButtonConstants` enumeration).
[in]	shift	The modifier keys (Shift, Ctrl, Alt) that were pressed during the double-click. Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the double-click's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the double-click's position relative to the control's upper-left corner.

Remarks: This event may be disabled.

See also: Click, MDblClick, RDblClick, XDblClick, ITextBox::DisabledEvents

◆ DestroyedControlWindow()

void DestroyedControlWindow ( LONG hWnd )

The control window was destroyed

Will be fired after the control window was destroyed.

Parameters

[in] hWnd The control's window handle.

See also: RecreatedControlWindow, ITextBox::hWnd

◆ DragMouseMove()

void DragMouseMove	(	SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y,
		LONG *	autoHScrollVelocity,
		LONG *	autoVScrollVelocity
	)

The mouse cursor was moved over the control's client area

Will be fired if the user moves the mouse cursor over the control's client area during a drag'n'drop operation.

Parameters

[in]	button	The pressed mouse buttons. Any combination of the values defined by VB's `MouseButtonConstants` enumeration is valid.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in,out]	autoHScrollVelocity	The speed multiplier for horizontal auto-scrolling. If set to 0, horizontal auto-scrolling is disabled; if set to a value less than 0, the control auto-scrolls to the left; if set to a value greater than 0, the control auto-scrolls to the right. The higher/lower the value is, the faster the control scrolls.
[in,out]	autoVScrollVelocity	The speed multiplier for vertical auto-scrolling. If set to vertical auto-scrolling is disabled; if set to a value less than 0, the control auto-scrolls upwardly; if set to a value greater than 0, the control auto-scrolls downwards. The higher/lower the value is, the faster the control scrolls.

See also: MouseMove, OLEDragMouseMove, ITextBox::DragScrollTimeBase, ITextBox::SetInsertMarkPosition, ITextBox::BeginDrag

◆ Drop()

void Drop	(	SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

A drag'n'drop operation ended successful

Will be fired if a drag'n'drop operation ended successful.

Parameters

[in]	button	The pressed mouse buttons. Any combination of the values defined by VB's `MouseButtonConstants` enumeration is valid.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.

See also: AbortedDrag, ITextBox::EndDrag

◆ KeyDown()

void KeyDown	(	SHORT *	keyCode,
		SHORT	shift
	)

A key was pressed while the control has the focus

Will be fired if the user presses a key while the control has the focus.

Parameters

[in,out]	keyCode	The pressed key. Any of the values defined by VB's `KeyCodeConstants` enumeration is valid.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.

Remarks: You may set keyCode to 0 to eat the message.
This event may be disabled.

See also: KeyUp, KeyPress, ITextBox::DisabledEvents

◆ KeyPress()

void KeyPress ( SHORT * keyAscii )

An alphanumeric key was pressed and released while the control has the focus

Will be fired if the user presses and releases an alphanumeric key while the control has the focus.

Parameters

[in,out] keyAscii The pressed key's ASCII code.

Remarks: You may set keyAscii to 0 to eat the message.
This event may be disabled.

See also: KeyDown, KeyUp, ITextBox::DisabledEvents

◆ KeyUp()

void KeyUp	(	SHORT *	keyCode,
		SHORT	shift
	)

A key was released while the control has the focus

Will be fired if the user releases a key while the control has the focus.

Parameters

[in,out]	keyCode	The released key. Any of the values defined by VB's `KeyCodeConstants` enumeration is valid.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.

Remarks: You may set keyCode to 0 to eat the message.
This event may be disabled.

See also: KeyDown, KeyPress, ITextBox::DisabledEvents

◆ MClick()

void MClick	(	SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

The user clicked into the control's client area

Will be fired if the user clicks into the control's client area using the middle mouse button.

Parameters

[in]	button	The mouse buttons that were pressed during the click. This should always be `vbMiddleButton` (defined by VB's `MouseButtonConstants` enumeration).
[in]	shift	The modifier keys (Shift, Ctrl, Alt) that were pressed during the click. Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the click's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the click's position relative to the control's upper-left corner.

Remarks: This event may be disabled.

See also: MDblClick, Click, RClick, XClick, ITextBox::DisabledEvents

◆ MDblClick()

void MDblClick	(	SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

The user double-clicked into the control's client area

Will be fired if the user double-clicks into the control's client area using the middle mouse button.

Parameters

[in]	button	The mouse buttons that were pressed during the double-click. This should always be `vbMiddleButton` (defined by VB's `MouseButtonConstants` enumeration).
[in]	shift	The modifier keys (Shift, Ctrl, Alt) that were pressed during the double-click. Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the double-click's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the double-click's position relative to the control's upper-left corner.

Remarks: This event may be disabled.

See also: MClick, DblClick, RDblClick, XDblClick, ITextBox::DisabledEvents

◆ MouseDown()

void MouseDown	(	SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

A mouse button was pressed over the control's client area

Will be fired if the user presses a mouse button while the mouse cursor is located over the control's client area.

Parameters

[in]	button	The pressed mouse button. Any of the values defined by VB's `MouseButtonConstants` enumeration or the `ExtendedMouseButtonConstants` enumeration is valid.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.

Remarks: This event may be disabled.

See also: MouseUp, Click, MClick, RClick, XClick, ExtendedMouseButtonConstants, ITextBox::DisabledEvents

◆ MouseEnter()

void MouseEnter	(	SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

The mouse cursor was moved into the control's client area

Will be fired if the user moved the mouse cursor into the control's client area.

Parameters

[in]	button	The pressed mouse buttons. Any combination of the values defined by VB's `MouseButtonConstants` enumeration or the `ExtendedMouseButtonConstants` enumeration is valid.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.

Remarks: This event may be disabled.

See also: MouseLeave, MouseHover, MouseMove, ExtendedMouseButtonConstants, ITextBox::DisabledEvents

◆ MouseHover()

void MouseHover	(	SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

property

The mouse cursor was moved into the control's client area a specified period of time before

Will be fired if the mouse cursor has been located over the control's client area for the number of milliseconds specified by the ITextBox::HoverTime property.

Parameters

[in]	button	The pressed mouse buttons. Any combination of the values defined by VB's `MouseButtonConstants` enumeration or the `ExtendedMouseButtonConstants` enumeration is valid.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.

Remarks: This event may be disabled.

See also: MouseEnter, MouseLeave, MouseMove, ITextBox::HoverTime, ExtendedMouseButtonConstants, ITextBox::DisabledEvents

◆ MouseLeave()

void MouseLeave	(	SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

The mouse cursor was moved out of the control's client area

Will be fired if the user moves the mouse cursor out of the control's client area.

Parameters

[in]	button	The pressed mouse buttons. Any combination of the values defined by VB's `MouseButtonConstants` enumeration or the `ExtendedMouseButtonConstants` enumeration is valid.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.

Remarks: This event may be disabled.

See also: MouseEnter, MouseHover, MouseMove, ExtendedMouseButtonConstants, ITextBox::DisabledEvents

◆ MouseMove()

void MouseMove	(	SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

The mouse cursor was moved over the control's client area

Will be fired if the user moves the mouse cursor over the control's client area.

Parameters

[in]	button	The pressed mouse buttons. Any combination of the values defined by VB's `MouseButtonConstants` enumeration or the `ExtendedMouseButtonConstants` enumeration is valid.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.

Remarks: This event may be disabled.

See also: MouseEnter, MouseLeave, MouseDown, MouseUp, MouseWheel, ExtendedMouseButtonConstants, ITextBox::DisabledEvents

◆ MouseUp()

void MouseUp	(	SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

A mouse button was released over the control's client area

Will be fired if the user releases a mouse button while the mouse cursor is located over the control's client area.

Parameters

[in]	button	The released mouse button. Any of the values defined by VB's `MouseButtonConstants` enumeration or the `ExtendedMouseButtonConstants` enumeration is valid.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.

Remarks: This event may be disabled.

See also: MouseDown, Click, MClick, RClick, XClick, ExtendedMouseButtonConstants, ITextBox::DisabledEvents

◆ MouseWheel()

void MouseWheel	(	SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y,
		ScrollAxisConstants	scrollAxis,
		SHORT	wheelDelta
	)

The mouse wheel was rotated over the control's client area

Will be fired if the user rotates the mouse wheel over the control's client area.

Parameters

[in]	button	The pressed mouse buttons. Any combination of the values defined by VB's `MouseButtonConstants` enumeration or the `ExtendedMouseButtonConstants` enumeration is valid.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]	hitTestDetails	Specifies the part of the control that the mouse cursor's position lies in. Any of the values defined by the `HitTestConstants` enumeration is valid.
[in]	scrollAxis	Specifies whether the user intents to scroll vertically or horizontally. Any of the values defined by the `ScrollAxisConstants` enumeration is valid.
[in]	wheelDelta	The distance the wheel has been rotated.

Remarks: This event may be disabled.

See also: MouseMove, ExtendedMouseButtonConstants, ScrollAxisConstants, ITextBox::DisabledEvents

◆ OLECompleteDrag()

void OLECompleteDrag	(	IOLEDataObject *	data,
		OLEDropEffectConstants	performedEffect
	)

An OLE drag'n'drop operation was completed

Will be fired after OLE drag'n'drop if the drag'n'drop operation was completed successfully.

Parameters

[in]	data	The object that holds the dragged data. The drop target may have added data to it.
[in]	performedEffect	The performed drop effect. Any of the values (except `odeScroll`) defined by the `OLEDropEffectConstants` enumeration is valid.

See also: ITextBox::OLEDrag, OLEStartDrag, IOLEDataObject::GetData

◆ OLEDragDrop()

void OLEDragDrop	(	IOLEDataObject *	data,
		OLEDropEffectConstants *	effect,
		SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

The data was dropped onto the control during OLE drag'n'drop

Will be fired during OLE drag'n'drop if the user completes the operation while the mouse cursor is located over the control's client area.

Parameters

[in]	data	The dropped data.
[in,out]	effect	On entry, a bit field of the drop effects (defined by the `OLEDropEffectConstants` enumeration) supported by the drag source. On return, this paramter must be set to the drop effect that the target finally executed.
[in]	button	The pressed mouse buttons. Any combination of the values defined by VB's `MouseButtonConstants` enumeration is valid.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.

Remarks: Don't forget to release any references that you hold to the data object.

See also: OLEDragEnter, OLEDragMouseMove, OLEDragLeave, MouseUp, ITextBox::RegisterForOLEDragDrop, ITextBox::FinishOLEDragDrop, OLEDropEffectConstants

◆ OLEDragEnter()

void OLEDragEnter	(	IOLEDataObject *	data,
		OLEDropEffectConstants *	effect,
		SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y,
		LONG *	autoHScrollVelocity,
		LONG *	autoVScrollVelocity
	)

The data was dragged into the control during OLE drag'n'drop

Will be fired during OLE drag'n'drop if the user moved the mouse cursor into the control's client area.

Parameters

[in]	data	The dragged data.
[in,out]	effect	On entry, a bit field of the drop effects (defined by the `OLEDropEffectConstants` enumeration) supported by the drag source. On return, this paramter must be set to the drop effect that the target wants to be used on drop.
[in]	button	The pressed mouse buttons. Any combination of the values defined by VB's `MouseButtonConstants` enumeration is valid.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in,out]	autoHScrollVelocity	The speed multiplier for horizontal auto-scrolling. If set to 0, horizontal auto-scrolling is disabled; if set to a value less than 0, the control auto-scrolls to the left; if set to a value greater than 0, the control auto-scrolls to the right. The higher/lower the value is, the faster the control scrolls.
[in,out]	autoVScrollVelocity	The speed multiplier for vertical auto-scrolling. If set to vertical auto-scrolling is disabled; if set to a value less than 0, the control auto-scrolls upwardly; if set to a value greater than 0, the control auto-scrolls downwards. The higher/lower the value is, the faster the control scrolls.

See also: OLEDragMouseMove, OLEDragLeave, OLEDragDrop, MouseEnter, ITextBox::RegisterForOLEDragDrop, OLEDropEffectConstants, ITextBox::DragScrollTimeBase

◆ OLEDragEnterPotentialTarget()

void OLEDragEnterPotentialTarget ( LONG hWndPotentialTarget )

The user has dragged the data into a potential drop target window during OLE drag'n'drop

Will be fired during OLE drag'n'drop if the user dragged the mouse cursor into a potential drop target window.

Parameters

[in] hWndPotentialTarget The potential drop target window's handle.

Remarks: Requires Windows Vista or newer.

See also: OLEDragLeavePotentialTarget, ITextBox::OLEDrag

◆ OLEDragLeave()

void OLEDragLeave	(	IOLEDataObject *	data,
		SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

The data was dragged out of the control during OLE drag'n'drop

Will be fired during OLE drag'n'drop if the user moves the mouse cursor out of the control's client area or if the user canceled the drag'n'drop operation.

Parameters

[in]	data	The dragged data.
[in]	button	The pressed mouse buttons. Any combination of the values defined by VB's `MouseButtonConstants` enumeration is valid.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.

Remarks: Don't forget to release any references that you hold to the data object.

See also: OLEDragEnter, OLEDragMouseMove, OLEDragDrop, MouseLeave, ITextBox::RegisterForOLEDragDrop

◆ OLEDragLeavePotentialTarget()

void OLEDragLeavePotentialTarget ( void )

The user has dragged the data out of a potential drop target window during OLE drag'n'drop

Will be fired during OLE drag'n'drop if the user dragged the mouse cursor out of a potential drop target window.

Remarks: Requires Windows Vista or newer.

See also: OLEDragEnterPotentialTarget, ITextBox::OLEDrag

◆ OLEDragMouseMove()

void OLEDragMouseMove	(	IOLEDataObject *	data,
		OLEDropEffectConstants *	effect,
		SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y,
		LONG *	autoHScrollVelocity,
		LONG *	autoVScrollVelocity
	)

The data was dragged over the control during OLE drag'n'drop

Will be fired during OLE drag'n'drop if the user moves the mouse cursor over the control's client area.

Parameters

[in]	data	The dragged data.
[in,out]	effect	On entry, a bit field of the drop effects (defined by the `OLEDropEffectConstants` enumeration) supported by the drag source. On return, this paramter must be set to the drop effect that the target wants to be used on drop.
[in]	button	The pressed mouse buttons. Any combination of the values defined by VB's `MouseButtonConstants` enumeration is valid.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the mouse cursor's position relative to the control's upper-left corner.
[in,out]	autoHScrollVelocity	The speed multiplier for horizontal auto-scrolling. If set to 0, horizontal auto-scrolling is disabled; if set to a value less than 0, the control auto-scrolls to the left; if set to a value greater than 0, the control auto-scrolls to the right. The higher/lower the value is, the faster the control scrolls.
[in,out]	autoVScrollVelocity	The speed multiplier for vertical auto-scrolling. If set to vertical auto-scrolling is disabled; if set to a value less than 0, the control auto-scrolls upwardly; if set to a value greater than 0, the control auto-scrolls downwards. The higher/lower the value is, the faster the control scrolls.

See also: OLEDragEnter, OLEDragLeave, OLEDragDrop, MouseMove, ITextBox::RegisterForOLEDragDrop, OLEDropEffectConstants, ITextBox::DragScrollTimeBase

◆ OLEGiveFeedback()

void OLEGiveFeedback	(	OLEDropEffectConstants	effect,
		VARIANT_BOOL *	useDefaultCursors
	)

The mouse cursor needs to be updated during OLE drag'n'drop

Will be fired during OLE drag'n'drop if the mouse cursor should be updated to visualize the current drop effect.

Parameters

[in]	effect	The current drop effect. It is chosen by the potential drop target. Any of the values defined by the `OLEDropEffectConstants` enumeration is valid.
[in,out]	useDefaultCursors	If set to `True`, the system's default mouse cursors are used to visualize the various drop effects. If set to `False`, custom mouse cursors are used. You must set the custom cursor within the handler of this event.

See also: ITextBox::OLEDrag, OLEQueryContinueDrag, OLEDropEffectConstants

◆ OLEQueryContinueDrag()

void OLEQueryContinueDrag	(	VARIANT_BOOL	pressedEscape,
		SHORT	button,
		SHORT	shift,
		OLEActionToContinueWithConstants *	actionToContinueWith
	)

The drag source should decide how to proceed with the OLE drag'n'drop operation

Will be fired during OLE drag'n'drop if the keyboard or mouse button state has changed. It gives the drag source the chance to cancel or complete the drag'n'drop operation.

Parameters

[in]	pressedEscape	If `True`, the user has pressed the `ESC` key since the last time this event was fired.
[in]	button	The pressed mouse buttons. Any combination of the values defined by VB's `MouseButtonConstants` enumeration is valid.
[in]	shift	The pressed modifier keys (Shift, Ctrl, Alt). Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in,out]	actionToContinueWith	Indicates whether to continue, cancel or complete the drag'n'drop operation. Any of the values defined by the `OLEActionToContinueWithConstants` enumeration is valid.

See also: ITextBox::OLEDrag, OLEGiveFeedback, OLEActionToContinueWithConstants

◆ OLEReceivedNewData()

void OLEReceivedNewData	(	IOLEDataObject *	data,
		LONG	formatID,
		LONG	Index,
		LONG	dataOrViewAspect
	)

Data has been stored in the data object

Will be fired during OLE drag'n'drop if data in the specified format has been written into the dragged data object.

Parameters

[in]	data	The object that holds the dragged data.
[in]	formatID	An integer value specifying the format the data object has received data for. Valid values are those defined by VB's `ClipBoardConstants` enumeration, but also any other format that has been registered using the `RegisterClipboardFormat` API function.
[in]	index	An integer value that is assigned to the internal `FORMATETC` struct's `lindex` member. Usually it is -1, but some formats like `CFSTR_FILECONTENTS` require multiple `FORMATETC` structs for the same format. In such cases each struct of this format will have a separate index.
[in]	dataOrViewAspect	An integer value that is assigned to the internal `FORMATETC` struct's `dwAspect` member. Any of the `DVASPECT_*` values defined by the Microsoft® Windows® SDK are valid. The default is `DVASPECT_CONTENT`.

Remarks: This event won't be fired if a custom IDataObject implementation was passed to the OLEDrag method.

See also: OLESetData, IOLEDataObject::GetData, RegisterClipboardFormat, FORMATETC, CFSTR_FILECONTENTS, DVASPECT

◆ OLESetData()

void OLESetData	(	IOLEDataObject *	data,
		LONG	formatID,
		LONG	Index,
		LONG	dataOrViewAspect
	)

Data is requested from the data object

Will be fired during OLE drag'n'drop if data is requested from the dragged data object in a data format, that you've chosen to support (in the OLEStartDrag event), but for which you didn't provide any data so far.
Call the provided object's SetData method to provide the data. If you chose to not support this data format, simply do nothing.

Parameters

[in]	data	The object that holds the dragged data.
[in]	formatID	An integer value specifying the format the drop target is requesting data for. Valid values are those defined by VB's `ClipBoardConstants` enumeration, but also any other format that has been registered using the `RegisterClipboardFormat` API function.
[in]	index	An integer value that is assigned to the internal `FORMATETC` struct's `lindex` member. Usually it is -1, but some formats like `CFSTR_FILECONTENTS` require multiple `FORMATETC` structs for the same format. In such cases each struct of this format will have a separate index.
[in]	dataOrViewAspect	An integer value that is assigned to the internal `FORMATETC` struct's `dwAspect` member. Any of the `DVASPECT_*` values defined by the Microsoft® Windows® SDK are valid. The default is `DVASPECT_CONTENT`.

Remarks: This event won't be fired if a custom IDataObject implementation was passed to the OLEDrag method.

See also: OLEStartDrag, IOLEDataObject::SetData, RegisterClipboardFormat, FORMATETC, CFSTR_FILECONTENTS, DVASPECT

◆ OLEStartDrag()

void OLEStartDrag ( IOLEDataObject * data )

The container holding the dragged data needs to be filled up

Will be fired after you called the OLEDrag method to determine the data you're offering. You must call the provided object's SetData method for each data format you're offering data in.

Parameters

[in] data The object that holds the dragged data.

Remarks: This event won't be fired if a custom IDataObject implementation was passed to the OLEDrag method.

See also: ITextBox::OLEDrag, OLESetData, OLECompleteDrag, IOLEDataObject::SetData

◆ OutOfMemory()

void OutOfMemory ( void )

The control couldn't allocate enough memory

Will be fired if the control cannot allocate enough memory to meet a specific request.

◆ RClick()

void RClick	(	SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

The user clicked into the control's client area

Will be fired if the user clicks into the control's client area using the right mouse button.

Parameters

[in]	button	The mouse buttons that were pressed during the click. This should always be `vbRightButton` (defined by VB's `MouseButtonConstants` enumeration).
[in]	shift	The modifier keys (Shift, Ctrl, Alt) that were pressed during the click. Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the click's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the click's position relative to the control's upper-left corner.

Remarks: This event may be disabled.

See also: ContextMenu, RDblClick, Click, MClick, XClick, ITextBox::DisabledEvents

◆ RDblClick()

void RDblClick	(	SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

The user double-clicked into the control's client area

Will be fired if the user double-clicks into the control's client area using the right mouse button.

Parameters

[in]	button	The mouse buttons that were pressed during the double-click. This should always be `vbRightButton` (defined by VB's `MouseButtonConstants` enumeration).
[in]	shift	The modifier keys (Shift, Ctrl, Alt) that were pressed during the double-click. Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the double-click's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the double-click's position relative to the control's upper-left corner.

Remarks: This event may be disabled.

See also: RClick, DblClick, MDblClick, XDblClick, ITextBox::DisabledEvents

◆ RecreatedControlWindow()

void RecreatedControlWindow ( LONG hWnd )

The control window was recreated

Will be fired after the control window was destroyed and recreated.
Some properties can't be changed after the control window was created. If such a property is changed and the control window already exists, it is destroyed and recreated.

Parameters

[in] hWnd The control's window handle.

See also: DestroyedControlWindow, ITextBox::hWnd

◆ ResizedControlWindow()

void ResizedControlWindow ( void )

The control window was resized

Will be fired after the control window was resized.

◆ Scrolling()

void Scrolling ( ScrollAxisConstants axis )

property

The control is being scrolled

Will be fired if the control is being scrolled.

Parameters

[in] axis The axis which is scrolled. Any of the values defined by the ScrollAxisConstants enumeration is valid.

Remarks: This event isn't raised if the MultiLine property is set to False.
This event may be disabled.

See also: ITextBox::MultiLine, ITextBox::ScrollBars, ITextBox::DisabledEvents, ScrollAxisConstants

◆ TruncatedText()

void TruncatedText ( void )

The text, that was entered into the control, got truncated

Will be fired if the text, that was entered into the control, got truncated. This happens in the following situations:

The control's resulting text would have been longer than allowed by the MaxTextLength property.
The control would have to scroll horizontally to display the entered text, but the AutoScrolling property doesn't include asHorizontal.
The control would have to scroll vertically to display the entered text, but the AutoScrolling property doesn't include asVertical.

See also: ITextBox::Text, ITextBox::MaxTextLength, ITextBox::AutoScrolling

◆ WritingDirectionChanged()

void WritingDirectionChanged ( WritingDirectionConstants newWritingDirection )

The control's writing direction has been changed by the user

Will be fired if the control's writing direction has been changed by the user.

Parameters

[in] newWritingDirection The control's new writing direction. Any of the values defined by the WritingDirectionConstants enumeration is valid.

Remarks: Due to limitations of Microsoft Windows, this event is not raised if the writing direction is changed using the control's default context menu.

See also: ITextBox::RightToLeft, WritingDirectionConstants

◆ XClick()

void XClick	(	SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

The user clicked into the control's client area

Will be fired if the user clicks into the control's client area using one of the extended mouse buttons.

Parameters

[in]	button	The mouse buttons that were pressed during the click. This should always be a constant defined by the `ExtendedMouseButtonConstants` enumeration.
[in]	shift	The modifier keys (Shift, Ctrl, Alt) that were pressed during the click. Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the click's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the click's position relative to the control's upper-left corner.

Remarks: This event may be disabled.

See also: XDblClick, Click, MClick, RClick, ExtendedMouseButtonConstants, ITextBox::DisabledEvents

◆ XDblClick()

void XDblClick	(	SHORT	button,
		SHORT	shift,
		OLE_XPOS_PIXELS	x,
		OLE_YPOS_PIXELS	y
	)

The user double-clicked into the control's client area

Will be fired if the user double-clicks into the control's client area using one of the extended mouse buttons.

Parameters

[in]	button	The mouse buttons that were pressed during the double-click. This should always be a constant defined by the `ExtendedMouseButtonConstants` enumeration.
[in]	shift	The modifier keys (Shift, Ctrl, Alt) that were pressed during the double-click. Any combination of the values defined by VB's `ShiftConstants` enumeration is valid.
[in]	x	The x-coordinate (in twips) of the double-click's position relative to the control's upper-left corner.
[in]	y	The y-coordinate (in twips) of the double-click's position relative to the control's upper-left corner.

Remarks: This event may be disabled.

See also: XClick, DblClick, MDblClick, RDblClick, ExtendedMouseButtonConstants, ITextBox::DisabledEvents

Public Member Functions

Detailed Description

Member Function Documentation

◆ TextChanged()

◆ AbortedDrag()

◆ BeforeDrawText()

◆ BeginDrag()

◆ BeginRDrag()

◆ Click()

◆ ContextMenu()

◆ DblClick()

◆ DestroyedControlWindow()

◆ DragMouseMove()

◆ Drop()

◆ KeyDown()

◆ KeyPress()

◆ KeyUp()

◆ MClick()

◆ MDblClick()

◆ MouseDown()

◆ MouseEnter()

◆ MouseHover()

◆ MouseLeave()

◆ MouseMove()

◆ MouseUp()

◆ MouseWheel()

◆ OLECompleteDrag()

◆ OLEDragDrop()

◆ OLEDragEnter()

◆ OLEDragEnterPotentialTarget()

◆ OLEDragLeave()

◆ OLEDragLeavePotentialTarget()

◆ OLEDragMouseMove()

◆ OLEGiveFeedback()

◆ OLEQueryContinueDrag()

◆ OLEReceivedNewData()

◆ OLESetData()

◆ OLEStartDrag()

◆ OutOfMemory()

◆ RClick()

◆ RDblClick()

◆ RecreatedControlWindow()

◆ ResizedControlWindow()

◆ Scrolling()

◆ TruncatedText()

◆ WritingDirectionChanged()

◆ XClick()

◆ XDblClick()