asp.net控件开发基础(8)

上一篇写了复合控件基本的概念，这次就继续上次的话题，来学习复合控件如何触发事件

有一些复合控件直接把按钮触发事件所需的事情封装好，另外一种则是自定义事件，更具灵活性，当然这是根据需要设计的。以下会以例子来说明的.下面我们假设我们控件中有两个按钮.以下不列出所有代码,具体可在文章最后下载代码.

(1) 直接实现按钮事件

在控件中(以下代码并非实现复合控件)直接实现事件则无需自定义事件,如下代码(如果对数据回传有些不熟悉的话,可先看第三篇,希望对你有帮助)

示例一(只列出局部代码,具体可在文章最后下载代码)

void IPostBackEventHandler.RaisePostBackEvent(string eventArgument)

{

if (eventArgument == "Previous")

PreviousText = "你点击了PreviousText按钮";

else if (eventArgument == "Next")

NextText = "你点击了NextText按钮";

}

protected override void RenderContents(HtmlTextWriter writer)

{

writer.AddAttribute(HtmlTextWriterAttribute.Onclick, Page.GetPostBackEventReference(this, "Previous"));

writer.RenderBeginTag(HtmlTextWriterTag.Button);

writer.Write(this.PreviousText);

writer.RenderEndTag();

writer.AddAttribute(HtmlTextWriterAttribute.Onclick, Page.GetPostBackEventReference(this, "Next"));

writer.RenderBeginTag(HtmlTextWriterTag.Button);

writer.Write(this.NextText);

writer.RenderEndTag();

}

还记得第三篇时示例一中下面的代码吗?此控件中只触发了一个事件,所以无需根据服务器传递的参数来判断出发哪个事件

//实现RaisePostBackEvent方法,处理回发事件

public void RaisePostBackEvent(string eventArgument)

{

OnClick(EventArgs.Empty);

}

RaisePostBackEvent方法有一个eventArgument参数用来传递事件数据.代码实现了一个空参数传递(eventArgument参数为空)的事件OnClick(EventArgs.Empty)

再比较一下示例一的代码,因为其用到了两个按钮

Page.GetPostBackEventReference方法用来传递参数

RaisePostBackEvent方法则以传递参数来判断触发哪个按钮

小结:

在控件中直接实现按钮事件,则无需定义自定义事件,但别忘了在RaisePostBackEvent方法中根据传递过来的不同参数来加以判断.

(2)以自定义事件实现

根据示例一上面的代码加上自定义委托和事件,如下代码(只列出局部代码,具体可在文章最后下载代码)

示例二

void IPostBackEventHandler.RaisePostBackEvent(string eventArgument)

{

if (eventArgument == "Previous")

OnClickPrevious(EventArgs.Empty);

else if (eventArgument == "Next")

OnClickNext(EventArgs.Empty);

}

调用代码如下

protected void NavButtons2_1_ClickPrevious(object sender, EventArgs e)

{

Label1.Text = "你点击了PreviousText按钮";

}

protected void NavButtons2_1_ClickNext(object sender, EventArgs e)

{

Label1.Text = "你点击了NextText按钮";

}

小结:在示例一的基础上去除直接实现好的按钮事件,然后自定义事件.

再次提醒如果大家对回发事件,还请再参考一些文章先弄清楚,或者也可以看看我写的第三篇文章.

好了,上面讲的都非复合控件,但复合控件实现起来却很相似,或者可以说更加简单.

下面先来看个简单的示例(大家知道button按钮有CommandName属性和CommandArgument属性)

示例三

<%@ Page Language="C#" %>

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

protected void Button1_Click(object sender, EventArgs e)

{

Label1.Text = "你点击了左按钮";

}

protected void Button2_Click(object sender, EventArgs e)

{

Label1.Text = "你点击了右按钮";

}

protected void btn_command(object sender, CommandEventArgs e)

{

switch (e.CommandName)

{

case "left":

Label2.Text = "你点击了左按钮";

break;

case "right":

Label2.Text = "你点击了右按钮";

break;

}

protected void btn2_command(object sender, CommandEventArgs e)

{

switch (e.CommandName)

{

case "left":

Button1_Click(this, e);

break;

case "right":

Button2_Click(this, e);

break;

}

</script>

</head>

<body>

<div>

<asp:Button ID="Button1" runat="server" OnClick="Button1_Click" Text="左按钮" />

<asp:Button ID="Button2" runat="server" Text="右按钮" OnClick="Button2_Click" /><br />

<br />

<asp:Label ID="Label1" runat="server"></asp:Label><br />

<br />

<asp:Button ID="Button3" runat="server" Text="左按钮" CommandName="left" OnCommand="btn_command" />

<asp:Button ID="Button4" runat="server"

Text="右按钮" OnCommand="btn_command" CommandName="right" /><br />

<br />

<asp:Label ID="Label2" runat="server"></asp:Label><br />

<br />

<asp:Button ID="Button5" runat="server" Text="左按钮" CommandName="left" OnCommand="btn2_command" /><asp:Button ID="Button6" runat="server"

Text="右按钮" OnCommand="btn2_command" CommandName="right" /></div>

</form>

</body>

</html>

以上代码以三种方式来实现按钮的触发事件.这里本应该再举一个数据绑定控件如(DataList控件的使用)的一个例子的一个例子的,这里目的只为了说明冒泡法的使用,冒泡法在DataList等数据绑定控定控件中最能体现出来.

那我们先来看下,在复合控件中怎么做?

1.直接实现按钮事件
2.以自定义事件实现

(1)以下为微软网站的示例代码,如下代码

示例四

namespace CompositionSampleControls

{

public class Composition2 : Control, INamingContainer

{

public int Value

{

get

{

this.EnsureChildControls();

return Int32.Parse(((TextBox)Controls[1]).Text);

}

set

{

this.EnsureChildControls();

((TextBox)Controls[1]).Text = value.ToString();

}

protected override void CreateChildControls()

{

// Add Literal Control

this.Controls.Add(new LiteralControl("<h3>" + "Value: "));

// Add Textbox

TextBox box = new TextBox();

box.Text = "0";

this.Controls.Add(box);

// Add Literal Control

this.Controls.Add(new LiteralControl("</h3>"));

// Add "Add" Button

Button addButton = new Button();

addButton.Text = "Add";

addButton.Click += new EventHandler(this.AddBtn_Click);

this.Controls.Add(addButton);

// Add Literal Control

this.Controls.Add(new LiteralControl(" | "));

// Add "Subtract" Button

Button subtractButton = new Button();

subtractButton.Text = "Subtract";

subtractButton.Click += new EventHandler(this.SubtractBtn_Click);

this.Controls.Add(subtractButton);

}

private void AddBtn_Click(Object sender, EventArgs e)

{

this.Value++;

}

private void SubtractBtn_Click(Object sender, EventArgs e)

{

this.Value--;

}

因为内部事件已经实现好了，所以比较简单，相信大家都看的懂。

再看复合控件的自定义事件,这里才是我们所要讲的重点.通常我们提倡在复合控件中采用冒泡法实现事件的上传,上一篇已经说过了,复合控件是一个树结构的控件,最典型的就是asp.net的数据邦定控件(特殊的复合控件)了如DataList,此控件有很多以Command结尾的事件,我们刚开始学这个控件的时候,总要考虑,如何在此控件中实现按钮事件,所采用的就是我们常说的"事件冒泡",当然还有另一种方法,应该说是普通的实现方法,asp.net服务器控件开发技术与示例称之为包含法,下面我们以例子来说明上面两种方法.

1.包含法

还是以微软的快速入门教程的代码为例.与上面的代码对比有几处变动,如下

注意粗体字,自定义事件为复合控件顶层的事件,而非其子控件button按钮的事件,button按钮的事件需调用顶层事件处理程序.即实现子控件事件上传的过程.

示例五

//自定义事件

public event EventHandler Change;

//自定义事件处理程序

protected void OnChange(EventArgs e) { Change(this, e); }

//子控件事件处理程序调用顶层事件处理程序,此处需注意

private void AddBtn_Click(Object sender, EventArgs e) { this.Value++; OnChange(EventArgs.Empty); }

2.冒泡法

上面已经介绍过了,并且MSDN也已经作出了详细的解释,控件可以将其定义的事件上传到控件顶层,在引发事件时处理事件,了解冒泡法,你需要了解以下两个方法

protected virtual bool OnBubbleEvent(

object source,

EventArgs args

);

protected void RaiseBubbleEvent(

object source,

EventArgs args

);

RaiseBubbleEvent不可重写,用于向上传递数据
要引发冒泡事件，控件必重写 OnBubbleEvent 看OnBubbleEvent方法,看下面代码
你需要先熟悉一下CommandEventArgs,其为Command事件提供了数据,通过其可以访问控件命令名称和参数,并根据不同参数和名称触发不同事件.其下代码为上一篇登录控件例子实现事件冒泡的方法,具体代码可在最后下载,且CreateChildControls方法中的触发事件的控件无须添加一个事件委托

addButton.Click += new EventHandler(this.AddBtn_Click);

protected override bool OnBubbleEvent(object source, EventArgs e) {

bool handled = false;

if (e is CommandEventArgs) {

CommandEventArgs ce = (CommandEventArgs)e;

if (ce.CommandName == "Logon") {

OnLogon(EventArgs.Empty);

handled = true;

}

return handled;

}

你也可以为控件定义的事件定义事件冒泡,引发该时间则必须调用RaiseBubbleEvent,示例三就是具体的例子使用

protected virtual void OnCommand(CommandEventArgs e) {

CommandEventHandler handler = (CommandEventHandler)Events[EventCommand];

if (handler != null)

handler(this,e);

// The Command event is bubbled up the control hierarchy.

RaiseBubbleEvent(this, e);

}

本次讲的重点在于冒泡法的使用,但我却用很多篇幅介绍写前面的东西,主要目的是为了让大家用复合控件与非符合控件进行比较,总的来说复合控件为我们带来了便利,不用实现IPostBackEventHandler接口,简化了操作.如果大家熟悉事件回传机制,则不难了解冒泡法的使用.最后还是要注意一点的是复合控件是一个树级的控件,即由子控件组成的一个控件,这次的例子很多都是直接取自书上和微软的教程上,只供大家参考吧.

好了,这次就写到这里,感觉这次写的并不是太好,望见谅,有错误请指出.

代码下载

posted on 2006-09-10 23:33 Clingingboy 阅读(10528) 评论(27) 编辑收藏网摘所属分类: B Asp.net组件开发

Feedback

#1楼 2006-09-11 11:07 mill[未注册用户]

Studying...
回复引用

#2楼 2006-11-13 16:30 ^_^[未注册用户]

不错，学习.
回复引用

#3楼 2006-11-13 16:30 ^_^[未注册用户]

http://www.carva.net/
回复引用

#4楼 2007-02-27 16:16 吴峰

CreateChildControls()中是否要加 this.Controls.Clear();呢??
否则Int32.Parse(((TextBox)Controls[1]).Text);可是会报错的哦!
它会加个"\r\n "的

要不就把1改为2
回复引用查看

#5楼 2007-05-18 10:56 zwgood

一个字"好"!!特别是代码
回复引用查看

#6楼 2007-06-22 16:14 忍[未注册用户]

我编译的时候报错了..请问是怎么会事??

编译错误
说明: 在编译向该请求提供服务所需资源的过程中出现错误。请检查下列特定错误详细信息并适当地修改源代码。

编译器错误信息: CS0234: 命名空间“MSPress.ServerControls”中不存在类型或命名空间名称“Design”(是缺少程序集引用吗?)

源错误:

行 17: DefaultEvent("Logon"),
行 18: DefaultProperty("Name"),
行 19: Designer(typeof(MSPress.ServerControls.Design.CompositeControlDesigner)) //
行 20: ]
行 21: public class CompositeLogin : WebControl, INamingContainer

回复引用

#7楼 2007-10-11 08:41 蒋希敏[未注册用户]

报Error Rending Control 错是怎么回事啊
回复引用

#8楼 2007-12-07 10:23 建友[未注册用户]

示例四中有一点小错误,应该将Controls[1]改为Controls[2],因为该复合控件的根为<div>,在<div>之后会有一个执行格式调整的LiteralControl(末尾也有一个),其Text属性为\r\n,所以Control[1]访问的是你在CreateChildControls中创建的第一个子控件.或者,你可以CreateChildControls的开始调用Clear方法.
回复引用

#9楼 [楼主] 2007-12-10 16:03 Clingingboy

@建友
恩,应该先clear,这个比较细的,谢谢:)
回复引用查看

#10楼 2007-12-27 13:33 virusplayer[未注册用户]

public int Value
{
get
{
this.EnsureChildControls();
return Int32.Parse(((TextBox)Controls[1]).Text);
}
set
{
this.EnsureChildControls();
((TextBox)Controls[1]).Text = value.ToString();
}
}
我也发现了，应该改成
public int Value
{
get
{
this.EnsureChildControls();
return Int32.Parse(((TextBox)Controls[2]).Text);
}
set
{
this.EnsureChildControls();
((TextBox)Controls[2]).Text = value.ToString();
}
}
我开始也不行，后来把document的trace设置true才发现应该是2的，这几天老大让研究控件开发，头都大了
回复引用

#11楼 2008-01-15 16:50 理想天空[未注册用户]

我用的是第四种,不知道是不是我没看仔细,看了以后感觉这种跟同常的没什么差别,
那我就是:
CreateChildControls方法里:
imgbtnFirst.Click += new ImageClickEventHandler(imgbtn_Click);

private void imgbtn_Click(object sender, ImageClickEventArgs e)
{
ImageButton myBtn = (ImageButton)sender;
switch (myBtn.CommandName.ToUpper())
{
case "FIRST":
this.PageIndex = 1;
break;
case "NEXT":
this.PageIndex++;
break;
case "PRE":
this.PageIndex--;
break;
case "END":
this.PageIndex = this.PageCount;
break;
case "GOTO":
this.PageIndex = int.Parse(this.txtGoto.Text.Trim());
break;
}
OnChageEventArg myArg = new OnChageEventArg(this.PageIndex, this.PageSize);
PageChange(sender, myArg);
}

但是怎么也进不了imgbtn_Click
是不是我少加了什么代码?请指教,谢谢
song0320@163.com
回复引用

#12楼 2008-01-15 17:14 理想天空[未注册用户]

加一个
我把
private ImageButton imgbtnFirst = new ImageButton();
定义在了类里,这个会不会有影响?
回复引用

#13楼 2008-01-16 10:35 Kenny.Song

可以了,呵呵,太高兴了
我在CreateChildControls方法里因为我在里面写了table,
只记得把控件加到table里,没有把table加到里控件进去
Controls.Add(myTable);

而是在Render事件里把
myTable.RenderControl(writer);

所以页面上有控件但是没激发
回复引用查看

#14楼 2008-01-22 16:36 CodeLover[未注册用户]

--引用--------------------------------------------------
忍: 我编译的时候报错了..请问是怎么会事??

编译错误
说明: 在编译向该请求提供服务所需资源的过程中出现错误。请检查下列特定错误详细信息并适当地修改源代码。

编译器错误信息: CS0234: 命名空间“MSPress.ServerControls”中不存在类型或命名空间名称“Design”(是缺少程序集引用吗?)

源错误:

行 17: DefaultEvent("Logon"),
行 18: DefaultProperty("Name"),
行 19: Designer(typeof(MSPress.ServerControls.Design.CompositeControlDesigner)) //
行 20: ]
行 21: public class CompositeLogin : WebControl, INamingContainer

--------------------------------------------------------
CS0234: The type or namespace name 'Design' does not exist in the namespace 'MSPress.ServerControls' (are you missing an assembly reference?)

回复引用

#15楼 2008-01-25 08:33 Roy_yan[未注册用户]

楼主呀，我会编写自定义控件全拜你所赐。
回复引用

#16楼 [楼主] 2008-01-25 08:54 Clingingboy

@CodeLover
缺少System.Design程序集
回复引用查看

#17楼 2008-04-02 21:39 欣宇

@忍
@CodeLover
你们用的是vs2005吧?我也遇到了这个问题,改成
Designer(typeof(System.Web.UI.Design.WebControls.CompositeControlDesigner))
就行了
回复引用查看

#18楼 2008-04-03 15:04 欣宇

学习这个系列一直到这篇了,总算自己心里有点底了,最近看黄忠成的<深入剖析asp.net组件设计>时,有点收获,作为一个补充写在博客里,希望大家多多交流
回复引用查看

#19楼 2008-08-05 09:38 shijie00ok[未注册用户]

忍: 我编译的时候报错了..请问是怎么会事??

编译错误
说明: 在编译向该请求提供服务所需资源的过程中出现错误。请检查下列特定错误详细信息并适当地修改源代码。

编译器错误信息: CS0234: 命名空间“MSPress.ServerControls”中不存在类型或命名空间名称“Design”(是缺少程序集引用吗?)

源错误:

行 17: DefaultEvent("Logon"),
行 18: DefaultProperty("Name"),
行 19: Designer(typeof(MSPress.ServerControls.Design.CompositeControlDesigner)) //
行 20: ]
行 21: public class CompositeLogin : WebControl, INamingContainer

--------------------------------------------------------
CS0234: The type or namespace name 'Design' does not exist in the namespace 'MSPress.ServerControls' (are you missing an assembly reference?)

上面楼主的方法说缺少 System.Design 的引用。我试着去添加引用结果呢？添加没有反映是怎么回事啊添加的引用也没有显示出来，

@欣宇我用的是2005 但是用你的方法也不行了写到System.Web.UI.Design 在往后面就写不出来了
回复引用