Export (0) Print
Expand All

Behavior Class

Represents the Behavior objects that are managed by a BehaviorService.


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

Public MustInherit Class Behavior

The Behavior type exposes the following members.

Protected methodBehaviorInitializes a new instance of the Behavior class.
Protected methodBehavior(Boolean, BehaviorService)Initializes a new instance of the Behavior class with the given BehaviorService.

Public propertyCursorGets the cursor that should be displayed for this behavior.
Public propertyDisableAllCommandsGets a value indicating whether MenuCommand objects should be disabled.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFindCommandIntercepts commands.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodOnDragDropPermits custom drag-and-drop behavior.
Public methodOnDragEnterPermits custom drag-enter behavior.
Public methodOnDragLeavePermits custom drag-leave behavior.
Public methodOnDragOverPermits custom drag-over behavior.
Public methodOnGiveFeedbackPermits custom drag-and-drop feedback behavior.
Public methodOnLoseCaptureCalled by the adorner window when it loses mouse capture.
Public methodOnMouseDoubleClickCalled when any double-click message enters the adorner window of the BehaviorService.
Public methodOnMouseDownCalled when any mouse-down message enters the adorner window of the BehaviorService.
Public methodOnMouseEnterCalled when any mouse-enter message enters the adorner window of the BehaviorService.
Public methodOnMouseHoverCalled when any mouse-hover message enters the adorner window of the BehaviorService.
Public methodOnMouseLeaveCalled when any mouse-leave message enters the adorner window of the BehaviorService.
Public methodOnMouseMoveCalled when any mouse-move message enters the adorner window of the BehaviorService.
Public methodOnMouseUpCalled when any mouse-up message enters the adorner window of the BehaviorService.
Public methodOnQueryContinueDragSends this drag-and-drop event from the adorner window to the appropriate Behavior or hit-tested Glyph.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

This class can be extended to develop any type of user interface behavior, including selection, drag, and resize behaviors.

For more information, see Behavior Service Overview.


Your Behavior type must be associated with a Glyph type. Glyph-independent behaviors are not supported.

The following code example demonstrates how to create your own class based on the Behavior class that responds to user clicks. This code example is part of a larger example provided for the BehaviorService class.

Class MyGlyph
    Inherits Glyph
    Private control As Control
    Private behaviorSvc As _

    Public Sub New(ByVal behaviorSvc As _
        System.Windows.Forms.Design.Behavior.BehaviorService, _
        ByVal control As Control)

        MyBase.New(New MyBehavior())
        Me.behaviorSvc = behaviorSvc
        Me.control = control
    End Sub

    Public Overrides ReadOnly Property Bounds() As Rectangle
            ' Create a glyph that is 10x10 and sitting
            ' in the middle of the control.  Glyph coordinates
            ' are in adorner window coordinates, so we must map
            ' using the behavior service.
            Dim edge As Point = behaviorSvc.ControlToAdornerWindow(control)
            Dim size As Size = control.Size
            Dim center As New Point(edge.X + size.Width / 2, edge.Y + _
                size.Height / 2)

            Dim bounds1 As New Rectangle(center.X - 5, center.Y - 5, 10, 10)

            Return bounds1
        End Get
    End Property

    Public Overrides Function GetHitTest(ByVal p As Point) As Cursor
        ' GetHitTest is called to see if the point is
        ' within this glyph.  This gives us a chance to decide
        ' what cursor to show.  Returning null from here means
        ' the mouse pointer is not currently inside of the glyph.
        ' Returning a valid cursor here indicates the pointer is
        ' inside the glyph,and also enables our Behavior property
        ' as the active behavior.
        If Bounds.Contains(p) Then
            Return Cursors.Hand
        End If

        Return Nothing

    End Function

    Public Overrides Sub Paint(ByVal pe As PaintEventArgs)
        ' Draw our glyph.  It is simply a blue ellipse.
        pe.Graphics.FillEllipse(Brushes.Blue, Bounds)

    End Sub

    ' By providing our own behavior we can do something interesting
    ' when the user clicks or manipulates our glyph.

    Class MyBehavior
        Inherits System.Windows.Forms.Design.Behavior.Behavior

        Public Overrides Function OnMouseUp(ByVal g As Glyph, _
            ByVal button As MouseButtons) As Boolean
            MessageBox.Show("Hey, you clicked the mouse here")
            Return True
            ' indicating we processed this event.
        End Function 'OnMouseUp
    End Class

End Class

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

© 2014 Microsoft