BehaviorService Class
Manages user interface in the designer. This class cannot be inherited.
Assembly: System.Design (in System.Design.dll)
When the BehaviorService is created, it adds a transparent window over the designer frame. The BehaviorService can then use this window to render user interface elements, called Glyph objects, as well as catch all mouse messages. In this way, the BehaviorService can control designer behavior.
The BehaviorService class supports a behavior stack, onto which Behavior objects can be pushed. When a message is intercepted through the transparent window, the BehaviorService can send the message to the Behavior at the top of the stack. This enables different user interface modes depending on the currently pushed Behavior. The BehaviorService is used to render all Glyph objects, such as selection borders, sizing handles, and smart tags. The BehaviorService also controls many design-time behaviors, such as using snaplines, dragging, and selecting.
For more information, see Behavior Service Overview.
The following code example demonstrates how to create your own Behavior based class that responds to user clicks.
Imports System Imports System.Collections.Generic Imports System.ComponentModel Imports System.Data Imports System.Drawing Imports System.Windows.Forms Imports System.Text Imports System.Windows.Forms.Design Imports System.Windows.Forms.Design.Behavior Namespace BehaviorServiceSample Public Class Form1 Inherits System.Windows.Forms.Form Private userControl As UserControl1 Private components As System.ComponentModel.IContainer = Nothing Public Sub New() MyBase.New() InitializeComponent() End Sub Protected Overrides Sub Dispose(ByVal disposing As Boolean) If disposing AndAlso (components IsNot Nothing) Then components.Dispose() End If MyBase.Dispose(disposing) End Sub Private Sub InitializeComponent() Me.userControl = New UserControl1() Me.SuspendLayout() Me.userControl.Location = New System.Drawing.Point(12, 13) Me.userControl.Name = "userControl" Me.userControl.Size = New System.Drawing.Size(143, 110) Me.userControl.TabIndex = 0 Me.ClientSize = New System.Drawing.Size(184, 153) Me.Controls.Add(userControl) Me.Name = "Form1" Me.Text = "Form1" Me.ResumeLayout(False) End Sub <STAThread()> _ Shared Sub Main() Application.EnableVisualStyles() Application.Run(New Form1()) End Sub End Class <Designer(GetType(MyDesigner))> _ Public Class UserControl1 Inherits UserControl Private components As System.ComponentModel.IContainer = Nothing Public Sub New() InitializeComponent() End Sub Protected Overrides Sub Dispose(ByVal disposing As Boolean) If disposing AndAlso (components IsNot Nothing) Then components.Dispose() End If MyBase.Dispose(disposing) End Sub Private Sub InitializeComponent() Me.Name = "UserControl1" Me.Size = New System.Drawing.Size(170, 156) End Sub 'InitializeComponent End Class Class MyDesigner Inherits ControlDesigner Private myAdorner As Adorner Protected Overrides Sub Dispose(ByVal disposing As Boolean) If disposing AndAlso (myAdorner IsNot Nothing) Then Dim b As System.Windows.Forms.Design.Behavior.BehaviorService _ = BehaviorService If (b IsNot Nothing) Then b.Adorners.Remove(myAdorner) End If End If End Sub Public Overrides Sub Initialize(ByVal component As IComponent) MyBase.Initialize(component) ' Add the custom set of glyphs using the BehaviorService. ' Glyphs live on adornders. myAdorner = New Adorner() BehaviorService.Adorners.Add(myAdorner) myAdorner.Glyphs.Add(New MyGlyph(BehaviorService, Control)) End Sub End Class Class MyGlyph Inherits Glyph Private control As Control Private behaviorSvc As _ System.Windows.Forms.Design.Behavior.BehaviorService 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 Get ' 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 End Namespace
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.