為 Microsoft Visual Studio .NET 設計工具建立可設計式元件（转贴）上

為 Microsoft Visual Studio .NET 設計工具建立可設計式元件


Shawn Burke
Microsoft Corporation 2000 年 7 月


摘要：Microsoft .NET 元件於通用語言執行階段，以管理程式碼撰寫建立而成。本文中討論 Microsoft .NET 元件如何提供開發人員一套全新的絕佳混合開發工具，不但類似於 Microsoft Visual Basic，同時提供與 ATL 或 MFC 更具關聯性的低階程式設計能力 (列印頁數共 26 頁)。

內容

簡介

元件範例

自訂中繼資料

瀏覽屬性

以相同方式出入：透過程式碼保存元件

元件設計工具

使用設計工具服務與基礎架構

元件授權

結論

簡介
　　Microsoft 即將推出的 Microsoft Visual Studio® .NET 版本，可帶給開發人員整合式的環境，不僅為傳統 C/C++ 應用程式，同時也為全新的 Microsoft .NET 元件提供豐富的配備。這些新元件是利用管理程式碼撰寫，並於通用語言執行階段建立，可提供開發人員一套全新的絕佳混合開發工具，不但類似於 Microsoft Visual Basic，同時提供與 Active Template Library (ATL) 或 Microsoft Foundation Class (MFC)，更具關聯性的低階程式設計能力。以產能為中心目標的控管環境，可以在傳統 COM 元件之間輕鬆地交互運作，它的出現也讓開發人員可以花更多的時間來建立大型元件，並減少對於記憶體遺漏、安全性和標頭檔的疑慮。

Visual Studio .NET (VS .NET) 除了提供 Microsoft .Net Framework 元件的開發設計之外，還有許多配備可讓元件充份利用 VS .NET 中的設計工具架構，讓其外觀和行為與 VS .NET 隨附的元件相似。在 VS .NET 設計工具中，您會發現所有開發管理元件的功能，皆使用 .Net Framework 元件本身，並允許設計階段及執行階段元件緊密整合。

元件範例
　　Microsoft .Net Framework 元件其實相當容易撰寫。如需與 Visual Studio .NET 設計工具執行，其惟一的條件是實行 System.ComponentModel.Component 所衍生的 System.ComponentModel.IComponent，也就是 IComponent 的預設實作。IComponent 可讓元件追蹤設計階段的資訊，諸如容器元件、名稱，或存取設計工具的服務。

舉例來說，我們撰寫類似下列之簡易 .NET 元件：

using System;
using System.ComponentModel;
public class BoolTracker : Component {
private bool state;
private EventHandler handler;
private static object EventValueChanged = new object();

public BoolTracker() {
}

public bool Value {
get {
return state;
}
set {
if (this.state != value) {
this.state = value;
OnValueChanged(new EventArgs());
}
}
}

public void AddOnValueChanged(EventHandler h) {
handler = (EventHandler)Delegate.Combine(handler, h);
}

protected virtual void OnValueChanged(EventArgs e) {
if (handler != null) {
handler(this, e);
}
}

public void RemoveOnValueChanged(EventHandler h) {
handler = (EventHandler)Delegate.Remove(handler, h);
}

}


很明顯的，這項元件的功用並不大，但如果將它置於 Visual Studio .NET Win 表單設計工具或者元件設計工具上，可以在瀏覽屬性中看到它的名稱，以及名為 Value 的屬性，其中的下拉式箭頭可將該值設定為「真」或「偽」。當該值介於「真」和「偽」之間時，則可觸發名為 OnValueChanged 的事件。

在設計工具中，元件往往僅佔成功的一半；最重要的部份則是組成中繼資料的屬性。中繼資料是有關於類別、屬性和事件等資訊。以 Value 屬性為例，屬性本身已經有相關聯的中繼資料，例如類型 (布林值)、行為 (讀/寫)，或名稱 (Value)。基本的中繼資料使用「反映」來擷取，「反映」也是通用語言執行階段允許使用者在執行階段時期，就其類型、基本類型、屬性、方法、建構函式、欄位或存取層級來檢查物件的方式。所有此類的資訊皆視為中繼資料。

自訂中繼資料
　　自訂中繼資料包含可附加於類別或者類別成員 (欄位、屬性或方法) 的部分自訂資訊，而這些資訊的類型通常可由特定客戶端分辨出來。在 Visual Studio .NET 設計工具中，自訂中繼資料為其中所有的可擴充性奠定基礎。而所有 VS .NET 設計工具能夠理解的中繼資料屬性，則是以 System.ComponentModel.MemberAttriubute 類型為基礎。該類型提供基礎類別，讓相關的設計工具可以藉由類型來快速識別出屬性。

不妨以具體的範例說明讓您更容易瞭解。舉例來說，我們不希望 Value 屬性顯示於瀏覽屬性中；此時可新增名為 System.ComponentModel.BrowsableAttribute 的中繼資料屬性，以便控制是否可瀏覽某項屬性。

[Browsable(false)]
public bool Value {
get {
return state;
}
set {
if (this.state != value) {
this.state = value;
OnValueChanged(new EventArgs());
}
}
}


在指定屬性時，若將 BrowsableAttribute 縮寫為 Browsable，則 C# 編譯器會自動加入 Attribute。唯一的限制條件，就是如果有指定的屬性值，必須在屬性類型中對應到建構函式，且該值必須為常數。在本範例中，BrowsableAttribute 有一個佔用單一布林參數的建構函式 browsable，且編譯器將本中繼資料屬性繫結到該建構函式，並建立出屬性類別的實例。倘若瀏覽屬性取得本物件，將在物件中列舉各項屬性並忽略本屬性，原因是該瀏覽屬性已採用本屬性為標記。這樣看起來好像是沒有屬性的物件。BrowsableAttribute 亦可套用到事件。

Microsoft .Net Framework 包含豐富的屬性組合，可控制設計工具與元件之間的配合運作方式。在下列清單中，包括許多有用的屬性，在您深入閱讀及了解後將發現更多的功用：

屬性名稱
描述

BrowsableAttribute
無論是控制屬性或事件都會顯示於瀏覽屬性中‧

BindableAttribute
判斷資料繫結者所繫結的屬性適當與否。

CategoryAttribute
指定在瀏覽屬性中應分類至何種類別 (「外觀」，「配置」，「行為」，「雜項」等等)。

DefaultEventAttribute/ DefaultPropertyAttribute
指定物件的預設事件/屬性。

HelpAttribute
指定屬性或事件的說明檔和主題。

LicenseProviderAttribute
指出可提供元件授權資訊的 LicenseProvider。

MergablePropertyAttribute
在瀏覽屬性中已選取和瀏覽多重元件時，可允許或避免包含屬性。

PersistableAttribute
程式碼由視覺設計工具產生時 (例如 Win 表單設計工具或元件設計工具)，可決定屬性的值是否保存在程式碼內。

PersistContentsAttribute
決定程式碼產生器是否應該重回到物件的非數值類型屬性，並保存屬性值的程式碼。ICollection 屬性類型即是典型的使用範例。

ShowInToolboxAttribute
決定工具箱內是否允許此元件。

ToolBoxItemAttriubte
指定工具箱內可用來建立類別的 ToolboxItem 類型



瀏覽屬性
　　您應該不難發現，在前面幾個章節曾多次提及瀏覽屬性。那是由於設計工具中絕大部分的參與元件，皆出現在瀏覽屬性中。設計工具負責組織並顯示元件，但是關於使用者修改部分，則必須在瀏覽屬性中進行。在舊版軟體中，瀏覽器顯示出原生 COM 物件，以便顯示已定義的資料類型子集：數值、字串、字型、顏色、影像、布林值和列舉型別。除此之外，其他的屬性管理工作則是由屬性頁畀或對話方塊來執行。然而，VS .NET 設計工具可以讓元件設計工具自行定義瀏覽屬性，包括如何處理物件所顯露的任何屬性類型，以及使用者編輯這些類型的方式。

.Net Framework 在許多內建類型中，使用這些編輯器，例如 System.Drawing.Color、System.Drawing.Font 或 Win Forms 控制項的 Dock 和 Anchor 屬性。

圖 1：屬性編輯器

此瀏覽屬性擴充性架構可提供四種基本功能類型：

數值轉換

子屬性

列舉型別

下拉式/快顯編輯器

System.ComponentModel.TypeConverter 處理前三項功能，而 System.WinForms.Design.UITypeEditor 所衍生的編輯器則處理最後一項功能。

您可能遇到的所有類型，諸如 .Net Framework 中的屬性，皆擁有內建的 TypeConverter。我們就先以 TypeConverter 類別為例，探討其用途並深入討論特定範例。以下的程式碼是 TypeConverter 的縮小版，其中包括已列示方法的某些特色，但是為講求簡潔必須有所省略，因此只留下核心方法。所有列示的方法皆為虛擬的，因此可以在必要的情況下覆寫。然而，既然 TypeConverter 是以基礎類別而非介面方式來實行，就表示大部份的重要功能已內建，您可以覆寫關於應用程式的部份。

public class TypeConverter {

//
// 數值轉換方式
//

// 判斷此 TypeConverter 可否
// 自指定類型轉換到目標類型
public virtual bool CanConvertFrom(
ITypeDescriptorContext context,
Type sourceType);

// 判斷此 TypeConverter 可否
// 自目標類型轉換到指定類型。
public virtual bool CanConvertTo(
ITypeDescriptorContext context,
Type destinationType);

// 在 TypeConverter 的
// 目標類型值中轉換數值
public virtual object ConvertFrom(
ITypeDescriptorContext context,
object value,
object[] arguments);

// 從 TypeConverters
// 目標類型的值轉換為目的地類型
public virtual object ConvertTo(
ITypeDescriptorContext context,
object value,
Type destinationType,
object[] arguments);

//
// 實例建立方式
//

// 建立目標類型物件
public virtual object CreateInstance(
ITypeDescriptorContext context,
PersistInfo persistInfo);

// 建立目標類型物件並
// 置放來自既定
// IDictionary 的值
public virtual object CreateInstance(
ITypeDescriptorContext context,
IDictionary propertyValues);

// 指出本 TypeConverter
// 是否了解如何建立
// 目標類型的物件實例
public virtual bool GetCreateInstanceSupported(
ITypeDescriptorContext context);

// 取得數值的 PersistInfo，
// 也就是說明
// 既定數值保存狀態的物件
public virtual PersistInfo GetPersistInfo(
ITypeDescriptorContext context,
object value);

//
// 子屬性方式
//

// 取得為此類型而顯示於
// 瀏覽屬性中的
// 子屬性。
public virtual PropertyDescriptorCollection GetProperties(
ITypeDescriptorContext context,
object value,
MemberAttribute[] attributes);

// 指出本類型是否應顯示「+」
// 於屬性瀏覽器中，以及是否應顯示子屬性。
public virtual bool GetPropertiesSupported(
ITypeDescriptorContext context);


//
// 預先設定/標準數值方法
//

// 取得本類型的一系列預先設定
// 「標準」數值
public virtual StandardValuesCollection GetStandardValues(
ITypeDescriptorContext context);

// 指定來自
// GetStandardValues 的數值組合是否為完整的
// 可用或有效數值清單
public virtual bool GetStandardValuesExclusive(
ITypeDescriptorContext context);

// 指定本 TypeConverter 是否可傳回
// 標準數值清單
public virtual bool GetStandardValuesSupported(
ITypeDescriptorContext context);

// 檢查數值是否為本類型之有效值。
public virtual bool IsValid(
ITypeDescriptorContext context, object value);

//
// 公用程式方式
//

// 排序屬性集合，將屬性以
// 名稱陣列進行排序。
protected PropertyDescriptorCollection SortProperties(
PropertyDescriptorCollection props,
string[] names);
}

public interface ITypeDescriptorContext : IServiceObjectProvider {

// 傳回與本內文有關之 IContainer
IContainer Container { get; }

// 傳回已查驗的實例。
// 數值是否已傳送到 TypeConverter，
// ITypeDescriptorContext::實例將傳回
// 提供數值的物件。
object Instance { get; }

// 從實例傳回物件進行變更前呼叫。
// 若傳回「偽」，則不可進行變更
// 且必須立刻中斷。
bool OnComponentChanging();

// 從實例傳回物件
// 進行變更後呼叫
void OnComponentChanged();
}


不難看出，TypeConverter 頗為龐大。其中也包含了 ITypeDescriptorContext 的簡要描述，因為它以參數的型式，出現在絕大多數的 TypeConverter 方法中。ITypeDescriptorContext 可允許存取使用服務，以及可提供任意值並傳送到 TypeConverter 之元件物件。

然而，若仔細察看 TypeConverter，會發現它並不如想像中複雜。它的功能可分為四個群組：

數值轉換：如瀏覽屬性等客戶端，必須輕鬆於字串表示之間轉換類型。TypeConverter 可為此提供一套標準的方法論，同時提供預先資格判定方法，以判斷既定轉換是否具有可能性。既然字串轉換十分普遍，TypeConverter 就針對 ConvertFromString 和 ConvertToString 提供 Helper 方法 (未顯示)。

實例建立與保存性 (persistence)：TypeConverter 負責為既定類型建立實例。TypeConverter 並不會強迫客戶端查驗建構函式或得到預設值，相反的，它允許類型作者控制整個流程。如此一來，TypeConverter 也扮演在設計工具中往來程式碼的元件保存角色。它可以同時建立和消耗 PersistInfo 物件，該物件描述與保存性相關的物件狀態部分 (通常包括往來的程式碼)，以及如何著手進行保存。

子屬性方法：TypeConverter 允許物件控制在瀏覽屬性中顯露的子屬性。System.Drawing.Font 就是一例：當展開的實例無法與 Font 物件本身的實際屬性完全符合時，所顯示的屬性。為達到清晰度和可用性而進行變更與重整。

標準值：如 enums 等諸多類型，皆包含已定義的數值子集。其它類型可能也有預先定義的集合，但可能同時還接受其它值。TypeConverter 允許客戶端查驗這些清單，並檢查是否可接受清單外的值。

在兩種方式中，TypeConverter 可選擇其中一種方法與屬性產生關聯。類型可藉由在類別宣告 (class declaration) 中的 TypeConverterAttribute，來指定其 TypeConverter。這些類別通常使用巢狀類別的轉換器，以便將類型和設計階段資訊結合為單一單位。此外，屬性也可以在屬性宣告本身指定 TypeConverter，以覆寫與屬性類型相關之 TypeConverter。當然，於該處指定之 TypeConverter 必須具備該特定類型的知識。您不可以單獨指定任何 TypeConverter，但如果您要改良既定屬性的顯示方式、新增或移除子屬性，或者為不同的字串轉換新增支援，則可以使用本方法。您可藉由某類型的預設 TypeConverter 取得並完成改善工作，同時將取得的類型指定為既定屬性的 TypeConverter。瀏覽屬性的另一部分，則與屬性編輯器有關。屬性編輯器的組織架構不如 TypeConverters 般複雜。為了讓不依賴或未連結到 Win 表單的編輯器，能夠達到最大的效能，因此編輯器沒有基礎編輯器類型。由於編輯器通常是由使用者介面 (UI) 驅動，因此在 .Net Framework 中所有標準編輯器，皆來自於 System.Drawing.Design.UITypeEditor。

public class UITypeEditor {

// 數值編輯後呼叫。
public virtual object EditValue(
ITypeDescriptorContext context, IServiceObjectProvider provider,
object value);

// 指定本編輯器是否可描繪
// 數值表示。
public virtual bool GetPaintValueSupported(
ITypeDescriptorContext context);

// 如果有的話，傳回本編輯器的 UI 樣式。
public virtual UITypeEditorEditStyle GetEditStyle(
ITypeDescriptorContext context);

// 於客戶端希望描繪數值的 UI 表示時
// 進行呼叫
public virtual void PaintValue(
ITypeDescriptorContext context,
object value,
Graphics canvas,
Rectangle rectangle);
}

public enum UITypeEditorEditStyle {

// 無互動式 UI 元件
None = 1,

// 強制回應 UI。屬性會顯示出 
// 按鈕以啟動對話方塊。
Modal = 2,

// 下拉式 UI。屬性會顯示出
// 向下箭頭按鈕，且 UI
// 位於類似組合下拉方塊的下拉式清單中。
DropDown = 3
}


// 本介面可藉由呼叫 UITypeEditor::EditValue 中的
// provider.GetServiceObject(typeof(IwinFormsEditorService))
// 取得。
public interface IWinFormsEditorService {

// 關閉目前顯示的下拉式清單
void CloseDropDown();

// 主宰數值的 UI 編輯
// 在下拉式清單中的既定控制。
void DropDownControl(Control control);

// 啟動強制回應對話方塊，以編輯屬性值。
DialogResult ShowDialog(Form dialog);
}


EditorAttribute 和 TypeConverterAttribute 一樣，都可以在套用的類型或特定類型的屬性中指定，並可覆寫類型本身所指定的值。

使用者在瀏覽屬性中按一下下拉式清單或橢圓按鈕時，會呼叫 UITypeEditor.EditValue。以下是下拉式編輯器中，實行 EditValue 的典型實作：

public override object EditValue(
ITypeDescriptorContext context, IServiceObjectProvider provider,
object value) {
object returnValue = value;

if (provider != null) {
IWinFormsEditorService edSvc = (IWinFormsEditorService)
provider.GetServiceObject(
typeof(IWinFormsEditorService));

if (edSvc != null) {
MyUIEditorControl uiEditor =
new MyUIEditorControl(edSvc);
edSvc.DropDownControl(uiEditor);
value = uiEditor.NewValue;
}
}

return value;
}


PaintValue 允許編輯器顯示出特定值的視覺化表示。舉例而言，WinForms 物件可使用本編輯器來編輯影像、色彩和字型。

圖 2：編輯器顯示畫面

以程式碼為基礎的範例：

public override void PaintValue(
ITypeDescriptorContext context,
object value,
Graphics canvas,
Rectangle rectangle) {
if (value is Color) {
Color color = (Color)value;
SolidBrush b = new SolidBrush(color);
canvas.FillRectangle(b, rectangle);
b.Dispose();
}
}

ColorEditor's PaintValue code.