This documentation is archived and is not being maintained.

Behavior.OnMouseDoubleClick Method

Called when any double-click message enters the adorner window of the BehaviorService.

Namespace:  System.Windows.Forms.Design.Behavior
Assembly:  System.Design (in System.Design.dll)

public virtual bool OnMouseDoubleClick(
	Glyph g,
	MouseButtons button,
	Point mouseLoc


Type: System.Windows.Forms.Design.Behavior.Glyph

A Glyph.

Type: System.Windows.Forms.MouseButtons

A MouseButtons value indicating which button was clicked.

Type: System.Drawing.Point

The location at which the click occurred.

Return Value

Type: System.Boolean
true if the message was handled; otherwise, false.

The OnMouseDoubleClick method is called when any double-click message enters the WndProc of the adorner window of the BehaviorService. The message is first passed here, to the top-most Behavior in the behavior stack. Returning true from this method signifies that the message was handled by the Behavior and should not continue to be processed. From here, the message is sent to the appropriate behavior.

The following code example demonstrates how to handle a double-click message. For a full code listing, see How to: Extend the Appearance and Behavior of Controls in Design Mode.

// When you double-click on an AnchorGlyph, the value of  
// the control's Anchor property is toggled. 
// Note that the value of the Anchor property is not set 
// by direct assignment. Instead, the  
// PropertyDescriptor.SetValue method is used. This  
// enables notification of the design environment, so  
// related events can be raised, for example, the 
// IComponentChangeService.ComponentChanged event. 

public override bool OnMouseDoubleClick(
    Glyph g, 
    MouseButtons button, 
    Point mouseLoc)
    base.OnMouseDoubleClick(g, button, mouseLoc);

    if (button == MouseButtons.Left)
        AnchorGlyph ag = g as AnchorGlyph;
        PropertyDescriptor pdAnchor = 

        if (ag.IsEnabled)
            // The glyph is enabled.  
            // Clear the AnchorStyle flag to disable the Glyph.
                ag.relatedControl.Anchor ^ ag.anchorStyle );
            // The glyph is disabled.  
            // Set the AnchorStyle flag to enable the Glyph.
                ag.relatedControl.Anchor | ag.anchorStyle);


    return true;

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0