HeaderItemEvents Interface Reference

This interface defines the set of events that can be raised by an HeaderItem object. More...

List of all members.

Public Member Functions
	OnClick ([in] IDispatch *Sender)
	This event occurs when the user clicks the header item.
	OnResize ([in] IDispatch *Sender)
	This event occurs when the user resizes the header item.
	OnBeginTrack ([in] IDispatch *Sender,[in] LONG Button,[in] IDispatch *ResultPtr)
	This event occurs when the user starts resizing the header item.
	OnTrack ([in] IDispatch *Sender,[in] LONG Width,[in] LONG Button,[in] IDispatch *ResultPtr)
	This event occurs when the user resizing the header item.
	OnDividerDblClick ([in] IDispatch *Sender,[in] IDispatch *ResultPtr)
	This event occurs when the user double clicked by the divider of the header items.
	OnBeginDrag ([in] IDispatch *Sender,[in] LONG Button,[in] IDispatch *ResultPtr)
	This event occurs when the user tries to move the column using Drag&Drop.
	OnEndDrag ([in] IDispatch *Sender,[in] LONG Button,[in] IDispatch *ResultPtr)
	This event occurs when the user moves the column using Drag&Drop.

---

Detailed Description

This interface defines the set of events that can be raised by an HeaderItem object.

---

Member Function Documentation

OnBeginDrag	(	[in] IDispatch *	Sender,
		[in] LONG	Button,
		[in] IDispatch *	ResultPtr
	)

This event occurs when the user tries to move the column using Drag&Drop.

Parameters:

	Sender	The object that raised the event.
	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.

Return values:

ResultPtr

This can be set to "TRUE" or "FALSE". If "FALSE" the header item can't be moved.

Since:

1.1.9.

OnBeginTrack	(	[in] IDispatch *	Sender,
		[in] LONG	Button,
		[in] IDispatch *	ResultPtr
	)

This event occurs when the user starts resizing the header item.

Parameters:

	Sender	The object that raised the event.
	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.

Return values:

ResultPtr

This can be set to "TRUE" or "FALSE". If "FALSE" then the header item can't be resized.

Since:

1.1.6.

OnClick

(

[in] IDispatch *

Sender

)

This event occurs when the user clicks the header item.

Parameters:

Sender

The object that raised the event.

OnDividerDblClick	(	[in] IDispatch *	Sender,
		[in] IDispatch *	ResultPtr
	)

This event occurs when the user double clicked by the divider of the header items.

Parameters:

Sender

The object that raised the event.

Return values:

ResultPtr

This can be set to "TRUE" or "FALSE". If "FALSE" the header item can't be resized.

Since:

1.1.6.

OnEndDrag	(	[in] IDispatch *	Sender,
		[in] LONG	Button,
		[in] IDispatch *	ResultPtr
	)

This event occurs when the user moves the column using Drag&Drop.

Parameters:

	Sender	The object that raised the event.
	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.

Return values:

ResultPtr

This can be set to "TRUE" or "FALSE". If "FALSE" the header item can't be moved.

Since:

1.1.9.

OnResize

(

[in] IDispatch *

Sender

)

This event occurs when the user resizes the header item.

Parameters:

Sender

The object that raised the event.

OnTrack	(	[in] IDispatch *	Sender,
		[in] LONG	Width,
		[in] LONG	Button,
		[in] IDispatch *	ResultPtr
	)

This event occurs when the user resizing the header item.

Parameters:

	Sender	The object that raised the event.
	Width	The current width of the header item.
	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.

Return values:

ResultPtr

This can be set to "TRUE" or "FALSE". If "TRUE" then the default behavoir will be disabled.

Since:

1.1.6.

---