程式師世界 >> 編程語言 >> .NET網頁編程 >> C# >> C#入門知識 >> 【C#】媽媽再也不用擔心自定義控件如何給特殊類型的屬性添加默認值了，附自定義GroupBox一枚，

【C#】媽媽再也不用擔心自定義控件如何給特殊類型的屬性添加默認值了，附自定義GroupBox一枚，

編輯：C#入門知識

【C#】媽媽再也不用擔心自定義控件如何給特殊類型的屬性添加默認值了，附自定義GroupBox一枚，

------------------更新：201411190903------------------

經過思考和實踐，發現套路中的第1條是不必要的，就是完全可以不用定義一個名為Default+屬性名的字段或屬性，只要實現Reset和ShouldSerialize這倆方法就可以了。關於這倆方法，應該是有相關文檔的，果然，在MSDN找到說法：http://msdn.microsoft.com/zh-cn/library/53b8022e(v=vs.80).aspx

------------------原文：201411182108------------------

標題有點那啥，但確實能表達我掌握此法後的心情。

寫自定義控件時往往會有一個需求，就是給屬性指定一個默認值（就是可以在VS中右鍵該屬性→重置），如果該屬性的類型是內置值類型還好，直接使用DefaultValue特性就好，例如：

[DefaultValue(false)]
public bool CanSelect
{
    get;
    set;
}

對於能夠根據字符串常量轉換得到的類型也還好，可以這樣：

[DefaultValue(typeof(Font), "宋體, 9pt")]
public Font TitleFont
{
    get;
    set;
}

但這種情況下，DefaultValue的第2個參數必須是字符串常量，不能是變量、字段、屬性、方法返回值啥的。題外，一個類型能否從字符串轉換得到，依賴的是該類型的TypeConverter特性指定的轉換類中的實現。有關TypeConverter的更多信息請參看：

http://msdn.microsoft.com/zh-cn/library/system.componentmodel.typeconverter(v=vs.80).aspx

回到正題，那麼問題來了，如果我想讓TitleFont的默認值是SystemFonts.DefaultFont咋辦？剛學了一招，下面通過一個自定義控件示例說明：

/// <summary>
/// 增強型GroupBox
/// </summary>
/// <remarks>
/// Author:AhDung
/// Update:201411181832，可獨立設置標題顏色和字體
/// </remarks>
public class GroupBoxEx : GroupBox
{
    static Font defaultTitleFont; //定義一個靜態字段
    /// <summary>
    /// 默認標題字體
    /// </summary>
    public static Font DefaultTitleFont //封裝該靜態字段，其實不封裝直接使用字段也行，但字段命名必須是DefaultXXX
    {
        get { return defaultTitleFont ?? (defaultTitleFont = SystemFonts.DefaultFont); }
    }

    Color titleColor;
    /// <summary>
    /// 獲取或設置標題顏色
    /// </summary>
    [Description("獲取或設置標題顏色")]
    [DefaultValue(typeof(Color), "0, 70, 213")]
    public Color TitleColor
    {
        get { return titleColor; }
        set
        {
            if (titleColor != value)
            {
                titleColor = value;
                this.Invalidate();
            }
        }
    }

    Font titleFont;
    /// <summary>
    /// 獲取或設置標題字體
    /// </summary>
    [Description("獲取或設置標題字體")]
    public Font TitleFont
    {
        get { return titleFont; }
        set
        {
            titleFont = value ?? DefaultTitleFont; //防止屬性被設為null
            this.Invalidate();
        }
    }

    /// <summary>
    /// 重置標題字體
    /// </summary>
    [EditorBrowsable(EditorBrowsableState.Never)]
    protected virtual void ResetTitleFont() //實現一個重置屬性默認值的方法，命名須為ResetXXX
    {
        this.TitleFont = null; //屬性setter中有null處理
    }

    /// <summary>
    /// 是否顯式設置標題字體
    /// </summary>
    [EditorBrowsable(EditorBrowsableState.Never)]
    protected virtual bool ShouldSerializeTitleFont() //實現一個指示是否把屬性值寫入窗體Designer文件的方法，命名須是ShouldSerializeXXX
    {
        return !titleFont.Equals(DefaultTitleFont);
    }

    /// <summary>
    /// 重繪
    /// </summary>
    protected override void OnPaint(PaintEventArgs e)
    {
        if ((Application.RenderWithVisualStyles && (Width >= 10)) && (Height >= 10))
        {
            TextFormatFlags flags = TextFormatFlags.PreserveGraphicsTranslateTransform | TextFormatFlags.PreserveGraphicsClipping | TextFormatFlags.TextBoxControl | TextFormatFlags.WordBreak;
            if (!this.ShowKeyboardCues)
            {
                flags |= TextFormatFlags.HidePrefix;
            }
            if (this.RightToLeft == RightToLeft.Yes)
            {
                flags |= TextFormatFlags.RightToLeft | TextFormatFlags.Right;
            }

            GroupBoxRenderer.DrawGroupBox(
                e.Graphics,
                this.ClientRectangle,
                this.Text,
                this.TitleFont,
                this.Enabled ? this.TitleColor : SystemColors.ControlDark,
                flags,
                this.Enabled ? System.Windows.Forms.VisualStyles.GroupBoxState.Normal : System.Windows.Forms.VisualStyles.GroupBoxState.Disabled);
        }
        else
        {
            base.OnPaint(e);
        }
    }

    /// <summary>
    /// 初始化該控件
    /// </summary>
    public GroupBoxEx()
    {
        SetStyle(ControlStyles.AllPaintingInWmPaint
            | ControlStyles.UserPaint
            | ControlStyles.OptimizedDoubleBuffer, true);

        titleColor = Color.FromArgb(0, 70, 213);
        ResetTitleFont(); //直接調用重置方法以初始化屬性值
    }
}

說明一下，寫這個控件的本意是讓GroupBox在NT6下，標題變得顯眼一點。NT5下默認就是顯眼的藍色，但NT6是黑色，不那麼顯眼，影響程序體驗。固然可以直接設置GroupBox的ForeColor和Font屬性達到目的，但這樣的話，它裡面的子控件會繼承，還得把子控件的這倆屬性改回來~蛋疼。所以為了能獨立設置GroupBox的標題的顏色和字體，增加了TitleColor和TitleFont這倆自定義屬性，也正是想把TitleFont的默認值設為SystemFonts.DefaultFont時遇到了本文的問題，幾經搜索，看了些有用的帖子，後來又從Control類的源碼中得到正果（上述例子參考的就是Control類中的標准做法），那麼既然解決了，就想著把招法和控件一起與大家分享一下。控件實現沒什麼好說的，下面主要就為非常規類型的屬性指定默認值的套路說一下。

就用上述控件中類型為Font、名為TitleFont的屬性來說事：

- 要有一個同類型的字段或屬性，命名必須為Default+屬性名，即DefaultTitleFont，並且為static。為該字段/屬性賦值想要的默認值，本例為SystemFonts.DefaultFont，可見這裡就不像DefaultValue只能賦值內置值類型或字符串常量那麼蛋疼了，可以隨意賦值~不然還說個球

- 要實現一個Reset+屬性名的無參無返回方法，即ResetTitleFont()。該方法的作用是重新把屬性賦值為默認值。本例因為在屬性的setter中有處理，即賦值為null時就替換為默認值，所以直接賦值null無礙，如果setter沒有這種處理，就需要賦值為上面的DefaultTitleFont~切記。至於修飾符無所謂，Control中是public virtual，考慮到這個方法沒必要讓外部調用，所以本例是protected virtual。至於加上[EditorBrowsable(EditorBrowsableState.Never)]特性是為了讓用戶在使用控件時，避免在VS智能提示中出現該方法，這也是Control中的做法。原因很顯然，這種方法是給設計器用的，不是給人用的，顯它做甚~礙眼

- 再實現一個ShouldSerialize+屬性名的方法，無參，返回bool。即ShouldSerializeTitleFont()，這個方法從字眼上是跟序列化有關的，我沒測試序列化，不知道是否有關，但可以肯定與是否把默認值寫入窗體的Designer文件有關，就是VS為窗體自動生成的那個含有InitializeComponent()方法的文件，不止如此，沒有這方法你根本玩不轉屬性重置，缺它不可。方法的邏輯是，如果為屬性賦的值就是默認值，那麼就告訴VS不要在InitializeComponent中顯式為該屬性賦值了。需要注意的是，返回true代表要顯式賦值，所以在寫該方法的return時請注意邏輯。修飾符什麼的與Reset方法一樣，沒要求

- 最後是在構造函數中為屬性賦初始值，由於Reset方法就是干這個的，所以本例直接調用這方法。這不是Control的做法，Control的構造函數中沒見到調用Reset方法，但有很多處理，包括調用一些internal方法，懶得追蹤了，也沒試過不賦初始值會不會有問題，保險起見，還是賦了一下。這裡再扯點題外，就是通過DefaultValue指定的默認值其實只是在VS中右鍵→重置時，讓VS不再往InitializeComponent顯式賦值，同時在PropertyGrid中讓值不再粗體顯式，並不代表屬性的初始值已經設置為DefaultValue指定的值，什麼意思，比如本例，雖然為TitleColor指定了DefaultValue，但如果不在構造函數中初始化titleColor = Color.FromArgb(0, 70, 213)的話，TitleColor值就會是default(Color)，即Color.Empty，所以在用DefaultValue後別忘了還得賦初始值，要記住DefaultValue是不負責賦值的。但是對於用Reset這種方法會不會一樣，沒試驗過，我猜也是不會自動賦初始值的，畢竟初始化是構造函數的工作，VS再強大再智能，也不太可能自作主張見到Reset就自動往構造函數中插一條~不合適也不科學。所以保險起見，構造函數中我還是對TitleFont賦了

最後，曬一下成果：

美白前：