Why IExtenderProvider
通過實現IExtenderProvider介面,Control可以將自身的屬性擴充給其它Control,從而為應用程式提供更豐富、更快捷、更強大的設計時和運行時表現能力。
What is IExtenderProvider
IExtenderProvider是定義將屬性擴充到其它Control的介面。IExtenderProvider只有一個方法成員CanExtend,返回布爾實值型別。
.net中實現IExtenderProvider的類有ComponentTray、ErrorProvider、HelpProvider、LocalizationExtenderProvider、PropertyTab和ToolTip。在Windows Forms設計中,經常用到類有ErrorProvider和ToolTip。
關於IExtenderProvider更詳細的資訊,請查看MSDN協助。
ms-help://MS.MSDNQTR.2003FEB.2052/cpref/html/frlrfsystemcomponentmodeliextenderproviderclasstopic.htm
How to use IExtenderProvider
要建立自訂IExtenderProvider擴充類,需要經過下面幾步,為了能更明確的指明要點,文章使用ToolTip為例介紹它是如何?IExtenderProvider的:
1. 引用System.ComponentModel命名空間;
[C#]
using System.ComponentModel;
[VB.NET]
Imports System.ComponentModel
2. 在自訂類中實現IExtenderProvider介面;
[C#]
public class ToolTip: Component, IExtenderProvider{
}
[VB.NET]
Public Class ToolTipClass ToolTip
Inherits Component
Implements IExtenderProvider
End Class
3. 使用ProvideProperty 的Attribute特性對外部公開擴充屬性;
[C#]
[ProvideProperty(“ToolTip”, typeof(Control))]
public class ToolTip: Component, IExtenderProvider{
}
[VB.NET]
<ProvideProperty(“ToolTip”, GetType(Control))> _
Public Class ToolTipClass ToolTip
Inherits Component
Implements IExtenderProvider
End Class
4. 實現IExtenderProvider介面的CanExtend方法,定義可以被擴充的Control的類型;
[C#]
public bool CanExtend (object extendee) {
// more code here.
}
[VB.NET]
Public Function CanExtend()Function CanExtend(extendee As Object) As Boolean
'more code here.
End Function
5. 實現對外公開的屬性。
Get PropertyName
[C#]
public string GetToolTip(Control extendee) {
// more code here.
}
[VB.NET]
Public Function GetToolTip()Function GetToolTip(extendee As Control) As String
' more code here.
End Function
Set PropertyName
[C#]
public void SetToolTip(Control extendee, string value){
// more code here.
}
[VB.NET]
Public Sub SetToolTip()Sub SetToolTip(extendee As Control, value As String)
' more code here.
End Sub
這裡的PropertyName必須與在第3中ProvideProperty公開的屬性名稱相同。可以看到,屬性不是通過get/set構造塊實現的,而是代之以方法。這有點像Java中實現屬性的方式。
get方法中返回的類型和set方法中value的類型是和自訂類要擴充的屬性的類型一致的。可以是字元型、數值型,甚至可以是枚舉類型。
Conclusion
在建立自己的IExtenderProvider類的過程中,進行了很多嘗試,也走了不少彎路,最後總結出下面幾個建議。需要聲明的是,這些建議不是強迫性的規定,也不是微軟對實現IExtenderProvider介面的官方建議(至少現在我沒有找到相關資料),但是依照該建議的原則,可以使您的自訂控制項有更好的可讀性和可維護性。
關於實現IExtenderProvider介面的建議如下:
1. 實現IExtenderProvider的類應是獨立的,它只應繼承自Component,而不是其它控制項;
2. 實現IExtenderProvider的類在返回CanExtend時應盡量排除自己,即不應將自己也做為可被擴充的對象;
3. 實現IExtenderProvider的類提供的擴充屬性應該是明了的、自解釋的;
4. 實現IExtenderProvider的類中所有被擴充Control的引用應盡量使用extendee變數表示。
參考資料
1. MSDN Library for .NET 2003,
2. Building Windows Forms Controls and Components with Rich Design-Time Features,Michael Weinhardt and Chris Sells
3. Reflector for .NET,Lutz Roeder