创建支持事件驱动的用户控件

简单的事件驱动

        我们要制作一个用户控件,该用户控件提供一个RadioButtonList包含Red/Green/Yellow三种颜色供用户选择，当用户选择某种颜色时可以在调用页上获取选中的颜色名称，我们要完成如下工作：
        首先，我们要为用户控件添加一个RadioButtonList(命名为:rblColors)，并设置3种可选颜色Red/Green/Yello，设置该控件的AutoPostBack属性为True以便可以自动触发反送，设置OnSelectedIndexChanged事件处理程序为rblColors_SelectedIndexChanged，即当选项发生变化时控件内部由该方法进行处理。

<asp:RadioButtonList ID="rblColors" runat="server" OnSelectedIndexChanged="rblColors_SelectedIndexChanged" AutoPostBack="True">
   <asp:ListItem Text="Red" Value="Red" Selected="true" />
   <asp:ListItem Text="Green" Value="Green" />
   <asp:ListItem Text="Yellow"  Value="Yellow" /> 
</asp:RadioButtonList>

        然后我们要为用户控件添加一个属性SelectedColor，以便外部可以获取当前控件的颜色值。

public string SelectedColor
...{
    get
    ...{
        return rblColors.SelectedValue;
    }
}

        接着为控件建立一个SelectedColorChanged事件，以便对外部标志选中的颜色更换这一事件发生。

public event EventHandler SelectedColorChanged;

        最后要把我们定义的事件委托应用到控件内部，让委托方法得以在正确的地方执行。那么SelectedColorChanged事件应该在rblColors的SelectedIndexChanged事件中发生，这里要注意SelectedColorChanged在用户没有指定处理程序时为null,要排除这种情况。

protected void rblColors_SelectedIndexChanged(object sender, EventArgs e)
...{
    if (null != SelectedColorChanged)
    ...{
        SelectedColorChanged(this, e);
    }
}

        完整的代码如下：

 

<%...@ Control Language="C#" AutoEventWireup="true" CodeFile="MyRadioButtonList.ascx.cs" Inherits="MyRadioButtonList" %>
<asp:RadioButtonList ID="rblColors" runat="server" OnSelectedIndexChanged="rblColors_SelectedIndexChanged" AutoPostBack="True">
    <asp:ListItem Text="Red" Value="Red" Selected="true" />
   <asp:ListItem Text="Green" Value="Green" />
   <asp:ListItem Text="Yellow"  Value="Yellow" /> 
</asp:RadioButtonList>

using System;
using System.Data;
using System.Configuration;
using System.Collections;
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 MyRadioButtonList : System.Web.UI.UserControl
...{
    /**//// <summary>
    /// Occurs when the selected index of the color list is changed.
    /// </summary>
    public event EventHandler SelectedColorChanged;

    /**//// <summary>
    /// Gets the selected Color of the color list.
    /// </summary>
    public string SelectedColor
    ...{
        get
        ...{
            return rblColors.SelectedValue;
        }
    }

    protected void rblColors_SelectedIndexChanged(object sender, EventArgs e)
    ...{
        if (null != SelectedColorChanged)
        ...{
            SelectedColorChanged(this, e);
        }
    }
}

自定义委托和参数的事件驱动

        在上面的例子中，SelectedColorChanged事件利用了EventHanlder委托，事件委托与事件数据相对应，EventHandler的原形如下：

[SerializableAttribute] 
[ComVisibleAttribute(true)] 
public delegate void EventHandler (
 Object sender,
 EventArgs e
)

        其中EventArgs是包含事件数据的类，该委托适用于没有事件数据的事件，那么如果我们需要传递事件数据（比如希望在事件处理中传递颜色值），就需要选择其他的或者自己定义一个委托，比如Repeater的ItemCommand事件利用了RepeaterItemEventHanlder委托，它的事件数据类为RepeaterItemEventArgs中就包含了Item类，可以传递Repeater的选中项。

        参照这种方式，我们建立自己的事件委托和对应的事件数据类。EventsArgs是所有事件数据类的基类，我们的事件数据类也要继承自这个基类，我们希望在事件数据中包含选中的颜色名称，那么为该类建立一个SelectedColor属性。

public delegate void ColorItemEventHander(object sender, ColorItemEventArgs e);

public class ColorItemEventArgs : EventArgs
...{
    private string _selectedColor;

    public string SelectedColor
    ...{
        get ...{ return _selectedColor; }
        set ...{ _selectedColor = value; }
    }

    public ColorItemEventArgs(string color)
    ...{
        _selectedColor = color;
    }
}

        修改我们用户控件中的SelectedColorChanged事件的委托为们自己定义的委托：

public event ColorItemEventHander SelectedIndexChanged;

        同时对于rblColors_SelectedIndexChanged事件也要修改，我们要在这里把事件数据传递出去：

protected void rblColors_SelectedIndexChanged(object sender, EventArgs e)
...{
    ColorItemEventArgs args = new ColorItemEventArgs(rblColors.SelectedValue);
    if (null != SelectedIndexChanged)
    ...{
        SelectedIndexChanged(this, args);
    }
}

使用自定义控件的事件

        现在我们要把自定义控件应用到页面中，首先声明用户控件并放置在前台页面上,并声明SelectedColorChanged事件的处理程序。

 

<%...@ Page Language="C#" AutoEventWireup="true"  CodeFile="Default.aspx.cs" Inherits="_Default" %>
<%...@ Register Src="~/MyRadioButtonList.ascx" TagName="ColorList" TagPrefix="uc1" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
        <uc1:ColorList id="MyRadioButtonList1" runat="server" OnSelectedColorChanged="MyRadioButtonList1_SelectedColorChanged">
        </uc1:ColorList></div>
    </form>
</body>
</html>

        在后台添加指定的事件处理程序，对于使用简单事件驱动的用户控件，在事件处理函数中可以通过查询SelectedColor属性获取选中的颜色名称：

 

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 MyRadioButtonList1_SelectedColorChanged(object sender, EventArgs e)
    ...{
        Response.Write(MyRadioButtonList1.SelectedValue);
    }
}

        对于使用了自定义委托和事件数据的用户控件，可以直接在事件数据内部获取选中的颜色名称：

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 MyRadioButtonList1_SelectedColorChanged(object sender, ColorItemEventArgs e)
    ...{
    // this代表用户控件的引用
        Response.Write(e.SelectedColor);
    }
}