ASP.NET的用户控件
你当前的位置:烁空 --> 技术文档全集

本文介绍如何在ASP.NET中创建用户控件,控件属性的动态修改以及控件的事件出发机制。

简介
ASP.NET的服务端控件使得WEB开发工作变得更为简单,功能更为强大。我们介绍过如何在ASP.NET页面中使用服务端控件。但是,如果服务端没有所要求的控件时该怎么办呢?

当然,ASP.NET不会给你变出一个莫须有的控件。事实上,可以动手作自己的控件来取代.NET提供的控件。这种控件就是用户控件,也正是本文讨论的话题。

编写第一个用户控件
有人认为,知道如何使用服务端控件可不一定说明编写用户控件是件容易的事。

事实上,编写一个基本用户控件(有时也称之为PAGELETS)并让ASP.NET页面象使用服务端控件那样使用这些控件的确是件简单的事。这里有一个简单示例:

BASIC.ASCX
<P>
THIS IS A USER CONTROL... REALLY!
</P>

这就是一个用户控件!看到这里,我想你会说我该不是喝醉了,头脑不清楚吧。但这段代码的确就是易于被使用的一个用户控件。尽管这个控件没有作什么事,却是关于什么是用户控件的一个很好说明。事情并不象想像得那么复杂。注意后缀.ASCX,它告诉网页这是一个用户控件。它没有什么特别含义,只是不让IIS去直接执行这段代码。

现在我们来创建一个用户控件,看下面的例子:

BASIC.ASPX
<%@ PAGE LANGUAGE="VB" %>
<%@ REGISTER TAGPREFIX="ASP101SAMPS" TAGNAME="SOMETEXT"
SRC="BASIC.ASCX" %>

<HTML>
<HEAD>
<TITLE>ASP.NET USER CONTROL SAMPLE - BASIC</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

<ASP101SAMPS:SOMETEXT RUNAT="SERVER" />

</BODY>
</HTML>

这段代码输出标准HTML页面,显示用户控件里的文字而不是标记。
那么它是怎么实现的呢?关键就在注册(REGISTER)说明。要注册控件,先要定义三个属性:

TAGPREFIX
定义控件位置的命名空间。有了命名空间制约,就可以在同一个网页里使用不同功能的同名控件。

TAGNAME
指向所使用控件的名字。在同一个命名空间里的控件名是唯一的。控件名一般都表明控件的功能。

SRC
指向控件的资源文件。资源文件使用虚路径("CONTROL.ASCX" 或 "/PATH/CONTROL.ASCX"),不能使用物理路径("C:PATHCONTROL.ASCX.")。

控件注册之后,就可以象其它服务端控件一样被使用。通过定义目标前缀(TAGPREFIX)和目标名(TAGNAME),就可以象使用服务端内建控件一样地进行使用。同时也确定了使用服务端运行(RUNAT="SERVER")方式。下面是网页调用用户控件的基本方式:
<TAGPREFIX:TAGNAME RUNAT="SERVER" />


给用户控件增加属性并赋值
下面我给控件加上两个属性,一个是COLOR,另一个是TEXT。

PROPERTIES.ASCX
<SCRIPT LANGUAGE="VB" RUNAT="SERVER">
PUBLIC COLOR AS STRING = "BLACK"
PUBLIC TEXT AS STRING = "THIS IS A USER CONTROL... REALLY!"
</SCRIPT>

<P>
<FONT COLOR="<%= COLOR %>">
<%= TEXT %>
</FONT>
</P>

这样就可以使用和改变控件的色彩和文字了。可以在初始化时赋值,还可以动态地修改这二个属性。

在同一个网页里可以重复调用这个控件并使用不同的属性值:
PROPERTIES.ASPX
<%@ PAGE LANGUAGE="VB" %>
<%@ REGISTER TAGPREFIX="ASP101SAMPS" TAGNAME="SOMETEXT"
SRC="PROPERTIES.ASCX" %>

<SCRIPT LANGUAGE="VB" RUNAT="SERVER">
SUB PAGE_LOAD(SENDER AS OBJECT, E AS EVENTARGS)
USERCTRL1.COLOR = "GREEN"
USERCTRL1.TEXT = "THIS CONTROL'S PROPERTIES WERE " _
& "SET PROGRAMMATICALLY!"
END SUB
</SCRIPT>

<HTML>
<HEAD>
<TITLE>ASP.NET USER CONTROL SAMPLE - PROPERTIES</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

<ASP101SAMPS:SOMETEXT RUNAT="SERVER" />

<ASP101SAMPS:SOMETEXT COLOR="RED" RUNAT="SERVER" />

<ASP101SAMPS:SOMETEXT TEXT="THIS IS QUITE COOL!" RUNAT="SERVER" />

<ASP101SAMPS:SOMETEXT COLOR="BLUE" TEXT="AIN'T IT" RUNAT="SERVER" />

<ASP101SAMPS:SOMETEXT ID="USERCTRL1" RUNAT="SERVER" />

</BODY>
</HTML>


还想再好些,用户控件是否能够有事件句柄呢?
用户控件几乎可以作任何事。下面的代码示范控件如何触发PAGE_LOAD事件。有了事件句柄,就不用多写其它的维护代码来控制控件的运行。控件可以自己触发事件。

在下面的代码中,封装了一个ASP的TEXTBOX控件。我将我的控件名属性与TEXTBOX的内容挂钩。

EVENTS.ASCX
<SCRIPT LANGUAGE="VB" RUNAT="SERVER">
SUB PAGE_LOAD(SRC AS OBJECT, E AS EVENTARGS)
DIM STRINITIALTEXT AS STRING = "PLEASE ENTER A NAME!"

IF PAGE.ISPOSTBACK THEN
IF TXTNAME.TEXT = STRINITIALTEXT
TXTNAME.TEXT = ""
END IF
ELSE
TXTNAME.TEXT = STRINITIALTEXT
END IF
END SUB

PUBLIC PROPERTY NAME AS STRING
GET
RETURN TXTNAME.TEXT
END GET
SET
TXTNAME.TEXT = VALUE
END SET
END PROPERTY
</SCRIPT>

NAME: <ASP:TEXTBOX ID="TXTNAME" RUNAT="SERVER" />

<ASP:REQUIREDFIELDVALIDATOR CONTROLTOVALIDATE="TXTNAME"
ID="VALTXTNAME" DISPLAY="DYNAMIC" RUNAT=SERVER>
PLEASE ENTER A NAME!
</ASP:REQUIREDFIELDVALIDATOR>


EVENTS.ASPX
<%@ PAGE LANGUAGE="VB" CLIENTTARGET="DOWNLEVEL" %>
<%@ REGISTER TAGPREFIX="ASP101SAMPS" TAGNAME="SOMETEXT"
SRC="PROPERTIES.ASCX" %>
<%@ REGISTER TAGPREFIX="ASP101SAMPS" TAGNAME="TEXTBOX"
SRC="EVENTS.ASCX" %>

<SCRIPT LANGUAGE="VB" RUNAT="SERVER">
SUB PAGE_LOAD(SENDER AS OBJECT, E AS EVENTARGS)
TXTLABEL.TEXT = ""

' THE TEXTBOX CONTROL HANDLES IT'S OWN STUFF
' IN IT'S OWN PAGE_LOAD EVENT HANDLER.
END SUB

SUB BTNSUBMIT_CLICK(SENDER AS OBJECT, E AS EVENTARGS)
' SETS THE LABEL TO THE TEXTBOX'S TEXT
TXTLABEL.TEXT = TXTNAME.NAME

' I DON'T NEED TO WORRY ABOUT VALIDATION SINCE
' MY USER CONTROL DOES IT FOR ME.
END SUB
</SCRIPT>

<HTML>
<HEAD>
<TITLE>ASP.NET USER CONTROL SAMPLE - VALIDATION & EVENTS</TITLE>
</HEAD>
<BODY BGCOLOR="#FFFFFF">

<FORM RUNAT="SERVER">

<ASP101SAMPS:TEXTBOX ID="TXTNAME" RUNAT="SERVER" />

<BR />

<ASP:BUTTON ID="BTNSUBMIT" ONCLICK="BTNSUBMIT_CLICK"
TEXT="SUBMIT" RUNAT="SERVER" />

</FORM>

<ASP101SAMPS:SOMETEXT ID="TXTLABEL" RUNAT="SERVER" />

</BODY>
</HTML>

这就是关于用户控件和应用的说明。无论你认为它是否简单,它肯定比使用传统ASP要容易。