CheckMouseOverContentState Method (PushButtonCell)

Overridden. Checks whether the mouse pointer is located over push button.

Syntax

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Overrides Function CheckMouseOverContentState( _
   ByVal e As MouseEventArgs, _
   ByVal type As MouseEventType, _
   ByRef handled As Boolean _
) As Boolean

'Usage
 
Dim instance As PushButtonCell
Dim e As MouseEventArgs
Dim type As MouseEventType
Dim handled As Boolean
Dim value As Boolean
 
value = instance.CheckMouseOverContentState(e, type, handled)

public override bool CheckMouseOverContentState( 
   MouseEventArgs e,
   MouseEventType type,
   ref bool handled
)

public: bool CheckMouseOverContentState( 
   MouseEventArgs* e,
   MouseEventType type,
   ref bool handled
) override

public:
bool CheckMouseOverContentState( 
   MouseEventArgs^ e,
   MouseEventType type,
   bool% handled
) override

Parameters

e: Mouse event data.
type: Specifies for what mouse event this function is called.
handled: Output. If true, custom code has performed the check.

Return Value

Should return true if mouse pointer is located over the content.

Remarks

A caller will take some action depending on returned value and mouse vent type. For example, if this method returns true and mouse event was MouseDown, the caller will set pressed state for the button. If mouse event is MouseUp and the state is pressed, the caller may execute a command (fire GridControl.CellExecuteCommand) associated with the push button.

Requirements

Target Platforms: Windows 7, 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

Reference

PushButtonCell Class
PushButtonCell Members
Base Implementation in CheckMouseOverContentState