Click here to Skip to main content
12,396,461 members (35,673 online)
Click here to Skip to main content

Tagged as

Stats

39.4K views
4.4K downloads
101 bookmarked
Posted

ButtonBar Control using .NET

, 3 Dec 2009 CPOL
Themed ButtonBar control supporting custom draw with full Designer support
using System;
using System.ComponentModel;
using System.Drawing;
using System.Drawing.Design;
using System.Xml;
using System.Xml.Schema;
using System.Xml.Serialization;
using ButtonBarsControl.Control;
using ButtonBarsControl.Design.Enums;
using ButtonBarsControl.Design.Generics;
using ButtonBarsControl.Design.Utility;

namespace ButtonBarsControl.Design.Layout
{
    /// <summary>
    /// Class responsible to store appearance information of a <see cref="ButtonBar"/>
    /// </summary>
    [TypeConverter(typeof (GenericConverter<AppearanceBar>))]
    public class AppearanceBar : ICloneable, IXmlSerializable
    {
        #region Private Fields

        private readonly ColorPair backStyle;
        private AppearanceBorder appearanceBorder;
        private int cornerRadius;
        private Color disabledMask;
        private Color focusedBorder;
        private Color normalBorder;

        #endregion

        #region Constructor

        /// <summary>
        /// Initialize new default instance.
        /// </summary>
        public AppearanceBar()
        {
            backStyle = new ColorPair();
            backStyle.AppearanceChanged += OnAppearanceChanged;
            appearanceBorder = new AppearanceBorder();
            appearanceBorder.AppearanceChanged += OnAppearanceChanged;
            Reset();
        }

        #endregion

        #region Public Property

        /// <summary>
        /// Gets background style of <see cref="ButtonBar"/>
        /// </summary>
        [Editor(typeof (ColorPair.ColorPairEditor), typeof (UITypeEditor))]
        [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
        public ColorPair BackStyle
        {
            get { return backStyle; }
        }

        /// <summary>
        /// Gets or Sets Normal border color of <see cref="ButtonBar"/>
        /// </summary>
        public Color NormalBorder
        {
            get { return normalBorder; }
            set
            {
                if (normalBorder == value)
                    return;
                normalBorder = value;
                OnAppearanceChanged();
            }
        }

        /// <summary>
        /// Gets or Sets disabled mask color of <see cref="ButtonBar"/>
        /// </summary>
        public Color DisabledMask
        {
            get { return disabledMask; }
            set
            {
                if (disabledMask == value)
                    return;
                disabledMask = value;
                OnAppearanceChanged();
            }
        }

        /// <summary>
        /// Gets or Sets focused border color of <see cref="ButtonBar"/>
        /// </summary>
        public Color FocusedBorder
        {
            get { return focusedBorder; }
            set
            {
                if (focusedBorder == value)
                    return;
                focusedBorder = value;
                OnAppearanceChanged();
            }
        }

        /// <summary>
        /// Gets border appearance of <see cref="ButtonBar"/>
        /// </summary>
        public AppearanceBorder AppearanceBorder
        {
            get { return appearanceBorder; }
            set
            {
                if (appearanceBorder == value)
                    return;
                appearanceBorder = value;
                OnAppearanceChanged();
            }
        }

        /// <summary>
        /// Gets corner radius of <see cref="ButtonBar"/>
        /// </summary>
        public int CornerRadius
        {
            get { return cornerRadius; }
            set
            {
                if (cornerRadius == value)
                    return;
                cornerRadius = value;
                OnAppearanceChanged();
            }
        }

        /// <summary>
        /// Indicates current object is Empty or not.
        /// </summary>
        [Browsable(false)]
        public bool IsEmpty
        {
            get
            {
                return backStyle.IsEmpty && appearanceBorder.IsEmpty && cornerRadius == 0 && focusedBorder.IsEmpty &&
                       normalBorder.IsEmpty && disabledMask.IsEmpty;
            }
        }

        #endregion

        #region Events

        /// <summary>
        /// Occurs when properties related to drawing has been modified.
        /// </summary>
        public event GenericEventHandler<AppearanceAction> AppearanceChanged;

        #endregion

        /// <summary>
        /// Fires <see cref="AppearanceChanged"/> event.
        /// </summary>
        /// <param name="sender">Event source.</param>
        /// <param name="tArgs">Object having event information.</param>
        protected virtual void OnAppearanceChanged(object sender, GenericEventArgs<AppearanceAction> tArgs)
        {
            if (AppearanceChanged != null)
            {
                AppearanceChanged(this, tArgs);
            }
        }

        /// <summary>
        /// Fires <see cref="AppearanceChanged"/> event. 
        /// </summary>
        protected virtual void OnAppearanceChanged()
        {
            if (AppearanceChanged != null)
            {
                AppearanceChanged(this, new GenericEventArgs<AppearanceAction>(AppearanceAction.Repaint));
            }
        }

        /// <summary>
        /// Get wether default values of the object has been modified.
        /// </summary>
        /// <returns>Returns true if default values has been modified for current object.</returns>
        public virtual bool DefaultChanged()
        {
            return ShouldSerializeBackStyle() || ShouldSerializeAppearanceBorder() || ShouldSerializeCornerRadius() ||
                   ShouldSerializeFocusedBorder() || ShouldSerializeNormalBorder() || ShouldSerializeDisabledMask();
        }

        #region Should Serialize and Reset Implementation

        /// <summary>
        /// Resets all properties to default value.
        /// </summary>
        public void Reset()
        {
            ResetBackStyle();
            ResetAppearanceBorder();
            ResetCornerRadius();
            ResetFocusedBorder();
            ResetNormalBorder();
            ResetDisabledMask();
        }

        /// <summary>
        /// Assigns Values of supplied <see cref="AppearanceBar"/> to current object.
        /// </summary>
        /// <param name="app"><see cref="AppearanceBar"/> object whose value is to be assigned.</param>
        public void Assign(AppearanceBar app)
        {
            backStyle.Assign(app.BackStyle);
            focusedBorder = app.FocusedBorder;
            normalBorder = app.NormalBorder;
            appearanceBorder.Assign(app.AppearanceBorder);
            cornerRadius = app.cornerRadius;
            disabledMask = app.disabledMask;
        }

        /// <summary>
        /// Resets <see cref="BackStyle"/> to default value.
        /// </summary>
        protected virtual void ResetBackStyle()
        {
            backStyle.Reset();
        }

        /// <summary>
        /// Resets <see cref="NormalBorder"/> to default value.
        /// </summary>
        protected virtual void ResetNormalBorder()
        {
            normalBorder = Color.Empty;
        }

        /// <summary>
        /// Resets <see cref="DisabledMask"/> to default value.
        /// </summary>
        protected virtual void ResetDisabledMask()
        {
            disabledMask = Color.Empty;
        }

        /// <summary>
        /// Resets <see cref="FocusedBorder"/> to default value.
        /// </summary>
        protected virtual void ResetFocusedBorder()
        {
            focusedBorder = Color.Empty;
        }

        /// <summary>
        /// Resets <see cref="AppearanceBorder"/> to default value.
        /// </summary>
        protected internal virtual void ResetAppearanceBorder()
        {
            appearanceBorder.Reset();
        }

        /// <summary>
        /// Resets <see cref="CornerRadius"/> to default value.
        /// </summary>
        protected internal virtual void ResetCornerRadius()
        {
            cornerRadius = 0;
        }

        /// <summary>
        /// Indicates wether <see cref="BackStyle"/> needs to be serialized by designer or not.
        /// </summary>
        /// <returns>true if designer needs to serialize</returns>
        protected virtual bool ShouldSerializeBackStyle()
        {
            return backStyle.DefaultChanged();
        }

        /// <summary>
        /// Indicates wether <see cref="NormalBorder"/> needs to be serialized by designer or not.
        /// </summary>
        /// <returns>true if designer needs to serialize</returns>
        protected virtual bool ShouldSerializeNormalBorder()
        {
            return normalBorder != Color.Empty;
        }

        /// <summary>
        /// Indicates wether <see cref="DisabledMask"/> needs to be serialized by designer or not.
        /// </summary>
        /// <returns>true if designer needs to serialize</returns>
        protected virtual bool ShouldSerializeDisabledMask()
        {
            return disabledMask != Color.Empty;
        }

        /// <summary>
        /// Indicates wether <see cref="FocusedBorder"/> needs to be serialized by designer or not.
        /// </summary>
        /// <returns>true if designer needs to serialize</returns>
        protected virtual bool ShouldSerializeFocusedBorder()
        {
            return focusedBorder != Color.Empty;
        }

        /// <summary>
        /// Indicates wether <see cref="AppearanceBorder"/> needs to be serialized by designer or not.
        /// </summary>
        /// <returns>true if designer needs to serialize</returns>
        protected virtual bool ShouldSerializeAppearanceBorder()
        {
            return appearanceBorder.DefaultChanged();
        }

        /// <summary>
        /// Indicates wether <see cref="CornerRadius"/> needs to be serialized by designer or not.
        /// </summary>
        /// <returns>true if designer needs to serialize</returns>
        protected virtual bool ShouldSerializeCornerRadius()
        {
            return cornerRadius != 0;
        }

        #endregion

        #region Implementation of ICloneable

        /// <summary>
        /// Creates a new object that is a copy of the current instance.
        /// </summary>
        /// <returns>
        /// A new object that is a copy of this instance.
        /// </returns>
        /// <filterpriority>2</filterpriority>
        public object Clone()
        {
            var app = new AppearanceBar();
            app.BackStyle.Assign((ColorPair) BackStyle.Clone());
            app.AppearanceBorder.Assign((AppearanceBorder) AppearanceBorder.Clone());
            app.CornerRadius = CornerRadius;
            app.DisabledMask = DisabledMask;
            app.FocusedBorder = FocusedBorder;
            app.NormalBorder = NormalBorder;
            return app;
        }

        #endregion

        #region Implementation of IXmlSerializable

        /// <summary>
        /// This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the <see cref="T:System.Xml.Serialization.XmlSchemaProviderAttribute"/> to the class.
        /// </summary>
        /// <returns>
        /// An <see cref="T:System.Xml.Schema.XmlSchema"/> that describes the XML representation of the object that is produced by the <see cref="M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter)"/> method and consumed by the <see cref="M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader)"/> method.
        /// </returns>
        public XmlSchema GetSchema()
        {
            return new XmlSchema();
        }

        /// <summary>
        /// Generates an object from its XML representation.
        /// </summary>
        /// <param name="reader">The <see cref="T:System.Xml.XmlReader"/> stream from which the object is deserialized. </param>
        public void ReadXml(XmlReader reader)
        {
            var doc = new XmlDocument();
            doc.Load(reader);

            if (doc.GetElementsByTagName("BackStyle").Count > 0)
            {
                var xml = "<ColorPair>" + doc.GetElementsByTagName("BackStyle")[0].InnerXml + "</ColorPair>";
                BackStyle.ReadXml(new XmlTextReader(xml, XmlNodeType.Document, null));
            }
            if (doc.GetElementsByTagName("NormalBorder").Count > 0)
                NormalBorder = PaintUtility.GetColor(doc.GetElementsByTagName("NormalBorder")[0].InnerText);

            if (doc.GetElementsByTagName("DisabledMask").Count > 0)
                DisabledMask = PaintUtility.GetColor(doc.GetElementsByTagName("DisabledMask")[0].InnerText);

            if (doc.GetElementsByTagName("FocusedBorder").Count > 0)
                FocusedBorder = PaintUtility.GetColor(doc.GetElementsByTagName("FocusedBorder")[0].InnerText);

            if (doc.GetElementsByTagName("AppearanceBorder").Count > 0)
            {
                var xml = "<AppearanceBorder>" + doc.GetElementsByTagName("AppearanceBorder")[0].InnerXml +
                          "</AppearanceBorder>";
                AppearanceBorder.ReadXml(new XmlTextReader(xml, XmlNodeType.Document, null));
            }

            if (doc.GetElementsByTagName("CornerRadius").Count > 0)
                CornerRadius = Convert.ToInt32(doc.GetElementsByTagName("CornerRadius")[0].InnerText);
        }

        /// <summary>
        /// Converts an object into its XML representation.
        /// </summary>
        /// <param name="writer">The <see cref="T:System.Xml.XmlWriter"/> stream to which the object is serialized. </param>
        public void WriteXml(XmlWriter writer)
        {
            writer.WriteStartElement("BackStyle");
            BackStyle.WriteXml(writer);
            writer.WriteEndElement();

            writer.WriteElementString("NormalBorder", PaintUtility.GetString(NormalBorder));
            writer.WriteElementString("DisabledMask", PaintUtility.GetString(DisabledMask));
            writer.WriteElementString("FocusedBorder", PaintUtility.GetString(FocusedBorder));

            writer.WriteStartElement("AppearanceBorder");
            AppearanceBorder.WriteXml(writer);
            writer.WriteEndElement();

            writer.WriteElementString("CornerRadius", CornerRadius.ToString());
        }

        #endregion
    }
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Manish Ranjan Kumar
Software Developer (Senior)
India India
No Biography provided

You may also be interested in...

| Advertise | Privacy | Terms of Use | Mobile
Web02 | 2.8.160721.1 | Last Updated 3 Dec 2009
Article Copyright 2009 by Manish Ranjan Kumar
Everything else Copyright © CodeProject, 1999-2016
Layout: fixed | fluid