ASP.NET自定義控件開發系列（一）

時間 2019-12-18

原文原文鏈接

最近作了一些自定義控件的開發工做，雖然遇到一些困難，可是感受自定義控件的開發在某些時候仍是頗有好處的，而後就想寫一個關於自定義控件開發的系列文章，一是給本身作個備忘；二是把遇到的問題記錄下來，但願後來者能少走彎路。
本系列但願經過對實例的講解，能包含自定義控件開發的大部份內容。

在系列（一）中先介紹一個簡單的實例，在網上看到一個很經典的入門級自定義控件的開發，本文即以此爲例。

一、需求：含有換行的TextBox控件的Text屬性獲取的文本可以自動在網頁中顯示換行
二、設計：重寫TextBox的Text屬性，將TextBox的回車換行符轉換爲html可以識別的
三、代碼：
WrapTextBox.cs:

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Text;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
namespace VeryCodes.Web.Controls
{
/// <summary>
/// 該控件擴展了TextBox控件，能夠經過設置屬性使回車換行轉換爲html的換行
/// 適用於多行文本框
/// </summary>
[DefaultProperty("Text")]
[ToolboxData("<{0}:WrapTextBox runat=server></{0}:WrapTextBox>")]
public class WrapTextBox : System.Web.UI.WebControls.TextBox
{
/// <summary>
/// 是否換行，默認爲false
/// </summary>
private bool _IsWrap = false;
/// <summary>
/// 重寫Text屬性
/// </summary>
public override string Text
{
get
{
//返回轉換後代碼
return format(base.Text);
}
set
{
base.Text = value;
}
}
/// <summary>
/// 字符串換行
/// </summary>
/// <param name="msg">輸入的字符串</param>
/// <returns>換行後的字符串</returns>
private string format(string msg)
{
if (IsWrap)
{
//關鍵部分，換行符的替換
msg = msg.Replace(" ", "").Replace(Convert.ToString((char)10), " ").Replace(Convert.ToString((char)13), "<br />");
}
return msg;
}
/// <summary>
/// 暴漏一個屬性，使控件使用者能夠設置是否使用換行符生成功能
/// </summary>
[Bindable(true)]
[Description("是否啓用生成換行符")]
[Category("外觀")]
[DefaultValue("false")]
public bool IsWrap
{
get
{
return _IsWrap;
}
set
{
_IsWrap = value;
}
}
}
}

四、測試：
(1)WrapTextBoxTest.aspx:

<%@ Page Language="C#" AutoEventWireup="true" CodeFile="WrapTextBoxTest.aspx.cs" Inherits="_Default" ValidateRequest="false" enableEventValidation="false" %>
<%@ Register Assembly="VeryCodes.Controls" Namespace="VeryCodes.Web.Controls" TagPrefix="cc2" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head runat="server">
<title>RichTextBox</title>
</head>
<body>
<form id="form1" runat="server">
<div>
WrapTextBox控件：<br />
輸入一段話：<br />
<cc2:WrapTextBox ID="WrapTextBox1" runat="server" IsWrap="True" Rows="5" TextMode="MultiLine"></cc2:WrapTextBox>
<br />
<asp:Button ID="Button1" runat="server" OnClick="Button1_Click" Text="提交" />
<br />
顯示：<br />
<asp:Label ID="Label1" runat="server"></asp:Label></div>
</form>
</body>
</html>

(2)WrapTextBoxTest.aspx.cs:

using System;
using System.Data;
using System.Configuration;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;
public partial class _Default : System.Web.UI.Page
{
protected void Page_Load(object sender, EventArgs e)
{
}
protected void Button1_Click(object sender, EventArgs e)
{
this.Label1.Text = this.WrapTextBox1.Text;
}
}

五、總結：
(1)這個自定義控件繼承了TextBox，這是擴充控件功能基本方式。經過添加或重寫屬性，加強控件的功能；
(2)DefaultProperty是設置控件默認的屬性的，這裏是Text屬性，就是當選擇這個控件的時候，在屬性窗口中自動被選中的是Text屬性；
(3)[ToolboxData("<{0}:WrapTextBox runat=server>")]這句設置控件拖動到頁面後的代碼
{0}表示控件標記的前綴，在這個例子中就是cc2：

<%@ Register Assembly="VeryCodes.Controls" Namespace="VeryCodes.Web.Controls" TagPrefix="cc2" %>

本節結束。

http://blog.bossma.cn/archives/2008/03/101