OnDragCaption Method

Invoked when a drag operation by clicking on the caption is about to start.

Syntax

Visual Basic

'Declaration
 
Protected Friend Overridable Function OnDragCaption( _
   ByVal pt As Point, _
   ByVal mouse As MouseDevice _
) As Boolean

C#

protected internal virtual bool OnDragCaption( 
   Point pt,
   MouseDevice mouse
)

Parameters

pt

The point relative to the upper left of the window.

mouse

Mouse device used to trigger the action

Return Value

True if the drag action was handled and therefore the window should not start a drag operation; false to allow the drag operation to occur.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2