Export (0) Print
Expand All

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)

public abstract class Glyph

The Glyph type exposes the following members.

  NameDescription
Protected methodGlyphInitializes a new instance of the Glyph class.
Top

  NameDescription
Public propertyBehaviorGets the Behavior associated with the Glyph.
Public propertyBoundsGets the bounds of the Glyph.
Top

  NameDescription
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 methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetHitTestProvides hit test logic.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodPaintProvides paint logic.
Protected methodSetBehaviorChanges the Behavior associated with the Glyph.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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 : Glyph
{
    Control control;
    BehaviorService behaviorSvc;

    public MyGlyph(BehaviorService behaviorSvc, Control control) : 
        base(new MyBehavior())
    {
        this.behaviorSvc = behaviorSvc;
        this.control = control;
    }

    public override Rectangle Bounds
    {
        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.
            Point edge = behaviorSvc.ControlToAdornerWindow(control);
            Size size = control.Size;
            Point center = new Point(edge.X + (size.Width / 2), 
                edge.Y + (size.Height / 2));

            Rectangle bounds = new Rectangle(
                center.X - 5,
                center.Y - 5,
                10,
                10);

            return bounds;
        }
    }

    public override Cursor GetHitTest(Point p)
    {
        // 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))
        {
            return Cursors.Hand;
        }

        return null;
    }

    public override void Paint(PaintEventArgs pe)
    {
        // Draw our glyph. It is simply a blue ellipse.
        pe.Graphics.FillEllipse(Brushes.Blue, Bounds);
    }

    // By providing our own behavior we can do something interesting 
    // when the user clicks or manipulates our glyph. 
    class MyBehavior : Behavior
    {
        public override bool OnMouseUp(Glyph g, MouseButtons button)
        {
            MessageBox.Show("Hey, you clicked the mouse here");
            return true; // indicating we processed this event.
        }
    }
}

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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.
Show:
© 2014 Microsoft