如何:在 ASP.NET 网页中包括用户控件

更新:2007 年 11 月

若要使用用户控件,请将其包括在 ASP.NET 网页中。当请求某个页面而该页包含用户控件时,在任何 ASP.NET 服务器控件所要执行的所有处理阶段中,该用户控件都将存在。有关这些处理阶段的更多信息,请参见 ASP.NET 页生命周期概述

在 Web 窗体页中包括用户控件

  1. 在包含 ASP.NET 网页中,创建一个 @ Register 指令,在其中包括:

    • 一个 TagPrefix 属性,该属性将前缀与用户控件相关联。此前缀将包括在用户控件元素的开始标记中。

    • 一个 TagName 属性,该属性将名称与用户控件相关联。此名称将包括在用户控件元素的开始标记中。

    • 一个 Src 属性,该属性定义包括的用户控件文件的虚拟路径。

      sbz9etab.alert_note(zh-cn,VS.90).gif说明:

      Src 属性值既可以是相对路径,也可以是从应用程序的根目录到用户控件源文件的绝对路径。为灵活使用,建议使用相对路径。代字号 (~) 表示应用程序的根目录。用户控件不能位于 App_Code 目录中。

  2. 在网页主体中,请在 form 元素内部声明用户控件元素。

  3. (可选)如果用户控件公开公共属性,请以声明方式设置这些属性。

示例

下面的示例演示一个包含用户控件的 ASP.NET 网页。该用户控件位于 Controls 文件夹的 Spinner.ascx 文件中。在该页中,该控件将被注册使用前缀 uc 和 Spinner 标记名称。该用户控件的 MinValue 和 MaxValue 属性以声明方式设置。

sbz9etab.alert_note(zh-cn,VS.90).gif说明:

有关此示例中使用的用户控件代码的详细信息,请参见如何:创建 ASP.NET 用户控件

<%@ Page Language="VB" %>
<%@ Register TagPrefix="uc" TagName="Spinner" 
    Src="~\Controls\Spinner.ascx" %>
<html>
<body>
<form runat="server">
    <uc:Spinner id="Spinner1" 
        runat="server" 
        MinValue="1" 
        MaxValue="10" />
</form>
</body>
<%@ Page Language="C#" %>
<%@ Register TagPrefix="uc" TagName="Spinner" 
    Src="~\Controls\Spinner.ascx" %>
<html>
<body>
<form runat="server">
    <uc:Spinner id="Spinner1" 
        runat="server" 
        MinValue="1" 
        MaxValue="10" />
</form>
</body>

请参见

概念

ASP.NET 用户控件概述

创建自定义 ASP.NET 控件路线图