建立支援簡單數據系結的 .NET Framework Windows Forms 使用者控件

備註

類別 DataSet 和相關類別是 2000 年代初的舊版 .NET Framework 技術，可讓應用程式在應用程式與資料庫中斷連線時使用記憶體中的數據。 這些技術特別適用於可讓使用者修改數據並將變更保存回資料庫的應用程式。 雖然數據集是經過證實的成功技術，但新 .NET 應用程式的建議方法是使用 Entity Framework Core。 Entity Framework 提供更自然的方式，以表格式數據作為物件模型使用，而且具有更簡單的程序設計介面。

在 Windows 應用程式中顯示表單上的資料時，您可以從 [工具箱] 中選擇現有的控制件，或者如果您的應用程式需要標準控件中無法使用的功能，則可以撰寫自定義控件。 本逐步解說示範如何建立實作DefaultBindingPropertyAttribute的控制項。 實作的 DefaultBindingPropertyAttribute 控件可以包含一個可以綁定到資料的屬性。 這類控制件類似於 TextBox 或 CheckBox。

如需控件撰寫的詳細資訊，請參閱 在設計時間開發 Windows Forms 控制件。

撰寫控件以用於數據系結案例時，您應該實作下列其中一個數據系結屬性：

數據系結屬性使用方式
將 DefaultBindingPropertyAttribute 實作在簡單控件上，例如 TextBox，用以顯示一列（或一個屬性）數據。 （本逐步解說頁面描述此過程。）
在控制項上實施 ComplexBindingPropertiesAttribute，如同 DataGridView，用於顯示數據清單（或數據表）。 如需詳細資訊，請參閱 建立支援複雜數據系結的 Windows Forms 使用者控件。
實作於控制項，例如 LookupBindingPropertiesAttribute，這些控制項顯示數據清單（或數據表），但也需要呈現單一列或屬性。 如需詳細資訊，請參閱 建立支援查閱數據系結的 Windows Forms 使用者控件。

本逐步解說會建立一個簡單的控制項，以顯示資料表中單一欄的資料。 此範例會使用 Northwind 範例資料庫中 Phone 表格的 Customers 列。 簡單的使用者控制會透過使用MaskedTextBox並將遮罩設定為電話號碼來顯示客戶的電話號碼，並以標準的電話號碼格式呈現。

在這個逐步解說期間，您將了解如何：

• 建立新的 Windows Forms 應用程式 （.NET Framework） 。

• 將新的 使用者控制項 新增至您的專案。

• 以可視化方式設計使用者控制件。

• 實作 DefaultBindingProperty 屬性。

• 使用 [數據源組態 精靈] 建立數據集。

• 將 [資料源] 視窗中的 [電話] 資料行設定為使用新的控制件。

• 建立表單以在新控件中顯示數據。

先決條件

若要完成本教學課程，您需要在 Visual Studio 中安裝的 .NET 桌面開發和資料儲存及處理工作負載。 若要安裝它們，請開啟 Visual Studio Installer，然後選擇您想要修改的 Visual Studio 版本旁的 [修改] (或 [更多>修改])。 請參閱 修改 Visual Studio。

本逐步解說使用 SQL Server Express LocalDB 和 Northwind 範例資料庫。

1. 如果您沒有 SQL Server Express LocalDB，請從 SQL Server Express 下載頁面或透過 Visual Studio 安裝程式進行安裝。 在 Visual Studio Installer中，您可以將 SQL Server Express LocalDB 安裝為 資料儲存和處理 工作負載的一部分，或安裝為個別元件。

2. 依照下列步驟安裝 Northwind 範例資料庫：

   1. 在 Visual Studio 中，開啟 [SQL Server 物件總管] 視窗。 （SQL Server 物件瀏覽器會安裝為 Visual Studio 安裝程式中資料儲存和處理工作負載的一部分。）展開 SQL Server 節點。 以滑鼠右鍵點擊您的 LocalDB 實例，然後選取 新增查詢。

      查詢編輯器視窗隨即開啟。

   2. 將 Northwind Transact-SQL 腳本 複製到剪貼簿。 此 T-SQL 腳本會從頭開始建立 Northwind 資料庫，並填入數據。

   3. 將 T-SQL 文稿貼到查詢編輯器中，然後選擇 [執行] 按鈕。

      在短時間內，查詢會完成執行，並建立 Northwind 資料庫。

建立 Windows Forms 應用程式

第一個步驟是建立 Windows Forms 應用程式 （.NET Framework）：

1. 在 Visual Studio 的 [ 檔案 ] 功能表上，選取 [ 新增>專案]。

2. 展開左側窗格中的 Visual C# 或 Visual Basic ，然後選取 [Windows 桌面]。

3. 在中間窗格中，選取 [Windows Forms 應用程式 ] 項目類型。

4. 將專案命名為 SimpleControlWalkthrough，然後選擇 [ 確定]。

   SimpleControlWalkthrough 項目隨即建立，並新增至 [方案總管]。

將使用者控件新增至專案

本逐步解說會從 使用者控件建立簡單的數據可系結控件。 將 使用者控件 專案新增至 SimpleControlWalkthrough 專案：

1. 從 [專案] 功能表中，選擇 [ 新增使用者控件]。

2. 在 [名稱] 區域中輸入 PhoneNumberBox ，然後按兩下 [ 新增]。

   PhoneNumberBox 控制項會新增至 方案總管，並在設計工具中開啟。

設計 PhoneNumberBox 控制件

本逐步解說會擴充現有的 MaskedTextBox 來建立 PhoneNumberBox 控件：

1. 將 MaskedTextBox 從 [工具箱] 拖曳至使用者控制項的設計介面。

2. 選取您剛才拖曳的 MaskedTextBox 智慧標記，然後選擇 [ 設定遮罩]。

3. 在 [輸入遮罩] 對話框中選取 [電話號碼]，然後按兩下 [確定] 來設定遮罩。

新增必要的數據系結屬性

針對支援資料系結的簡單控制項，請實作 DefaultBindingPropertyAttribute：

1. 將 PhoneNumberBox 控制件切換至程式代碼檢視。 （在 [ 檢視] 功能表上，選擇 [ 程序代碼]。

2. 以下列內容取代 PhoneNumberBox 中的程式代碼：

   C#

   using System.Windows.Forms;
   
   namespace CS
   {
       [System.ComponentModel.DefaultBindingProperty("PhoneNumber")]
       public partial class PhoneNumberBox : UserControl
       {
           public string PhoneNumber
           {
               get{ return maskedTextBox1.Text; }
               set{ maskedTextBox1.Text = value; }
           }
   
           public PhoneNumberBox()
           {
               InitializeComponent();
           }
       }
   }
   

   VB

   <System.ComponentModel.DefaultBindingProperty("PhoneNumber")>
   Public Class PhoneNumberBox
   
       Public Property PhoneNumber() As String
           Get
               Return MaskedTextBox1.Text
           End Get
           Set(ByVal value As String)
               MaskedTextBox1.Text = value
           End Set
       End Property
   End Class
   

3. 從 [ 建置] 功能表中，選擇 [ 建置方案]。

從資料庫建立數據源

此步驟會使用 數據源組態 精靈，根據 Customers Northwind 範例資料庫中的數據表建立數據源。 您必須能夠存取 Northwind 範例資料庫，才能建立連線。 如需設定 Northwind 範例資料庫的詳細資訊，請參閱 如何：安裝範例資料庫。

1. 若要開啟 [數據源 ] 視窗，請在 [ 數據 ] 功能表上，按兩下 [ 顯示數據源]。

2. 在 [ 數據源] 視窗中，選取 [ 新增數據源 ] 以啟動 [數據源組態 精靈]。

3. 在 [ 選擇數據源類型 ] 頁面上，選取 [ 資料庫]，然後選取 [ 下一步]。

4. 在 [ 選擇您的數據連線 ] 頁面上，執行下列其中一項動作：

   • 如果下拉式清單中有 Northwind 範例資料庫的數據連線可用，請選取它。

   • 選取 [新增連線 ] 以啟動 [ 新增/修改連線 ] 對話框。

5. 如果您的資料庫需要密碼，請選取包含敏感數據的選項，然後選取 [ 下一步]。

6. 在 [ 將連接字串儲存至應用程式組態檔 ] 頁面上，按 [下一步]。

7. 在 [ 選擇您的資料庫物件] 頁面上，展開 [ 數據表] 節點。

8. 選取Customers表格，然後選取 [完成]。

   NorthwindDataSet 會新增至您的專案，而Customers數據表會出現在 [數據源] 視窗中。

將電話欄設定為使用 PhoneNumberBox 控制項

在 數據源 視窗中，您可以在將項目拖曳到窗體之前，先設定要建立的控制項。

1. 在設計工具中，開啟 Form1。

2. 展開 [資料源] 視窗中的 [客戶] 節點。

3. 按兩下 [客戶] 節點上的下拉式清單箭號，然後從控件清單中選擇 [ 詳細數據 ]。

4. 按兩下 [電話] 資料 行上的下拉式清單箭號，然後選擇 [ 自定義]。

5. 從 [資料 UI 自定義選項] 對話方塊中的 [相關聯控件] 清單中選取 PhoneNumberBox。

6. 按兩下 [電話 ] 資料行上的下拉式清單箭號，然後選擇 [PhoneNumberBox]。

控制項加入至表單

您可以從數據源視窗將項目拖曳到表單上，以建立資料繫結控制項。

若要在窗體上建立數據綁定控件，請將主要 Customers 節點從 [數據源 ] 視窗拖曳到窗體上，並確認 PhoneNumberBox 控件是用來在 Phone 數據行中顯示數據。

具有描述性標籤的數據綁定控件會出現在表單上，以及用於巡覽記錄的工具帶（BindingNavigator）。 NorthwindDataSet、CustomersTableAdapter 和 BindingSourceBindingNavigator 會出現在元件匣中。

執行應用程式

按 F5 以執行應用程式。

後續步驟

根據您的應用程式需求，建立支援數據系結的控件之後，您可能會想要執行幾個步驟。 一些典型的後續步驟包括：

• 將自定義控制項放在控制元件連結庫中，讓您可以在其他應用程式中重複使用它們。

• 建立支援更複雜的數據系結案例的控件。 如需詳細資訊，請參閱 建立支援複雜數據系結的 Windows Forms 使用者控件 和 建立支援查閱數據系結的 Windows Forms 使用者控件。

相關內容

• 將 Windows Forms 控制項繫結至 Visual Studio 中的資料
• 從 [數據源] 視窗拖曳時，設定要建立的控件