This documentation is archived and is not being maintained.

Glyph Class

Represents a single user interface (UI) entity managed by an Adorner.

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

'Declaration
Public MustInherit Class Glyph
'Usage
Dim instance As Glyph

The sole purpose of a Glyph is to paint and hit test. A Glyph does not have a window handle (HWND), as it is rendered on the adorner window control of the BehaviorService. Each Glyph can have a Behavior associated with it. A successfully hit-tested Glyph has the opportunity to push a new or different Behavior onto the behavior stack of the BehaviorService.

For more information, see Behavior Service Overview.

The following example demonstrates how to create your own Glyph based class with Behavior associated with it. 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 _
        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

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

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
Show: