WebPart 类

定义

public ref class WebPart abstract : System::Web::UI::WebControls::WebParts::Part, System::Web::UI::WebControls::WebParts::IWebActionable, System::Web::UI::WebControls::WebParts::IWebEditable, System::Web::UI::WebControls::WebParts::IWebPart

public abstract class WebPart : System.Web.UI.WebControls.WebParts.Part, System.Web.UI.WebControls.WebParts.IWebActionable, System.Web.UI.WebControls.WebParts.IWebEditable, System.Web.UI.WebControls.WebParts.IWebPart

type WebPart = class
    inherit Part
    interface IWebPart
    interface IWebActionable
    interface IWebEditable

Public MustInherit Class WebPart
Inherits Part
Implements IWebActionable, IWebEditable, IWebPart

继承

Object

Control

WebControl

Panel

Part

WebPart

派生

System.Web.UI.WebControls.WebParts.GenericWebPart

System.Web.UI.WebControls.WebParts.ProxyWebPart

实现

IWebActionable IWebEditable IWebPart

示例

下面的代码示例演示如何创建 WebPart 控件并在网页中引用它。

该示例的第一部分包含名为 的TextDisplayWebPart自定义WebPart控件的代码。 此控件演示如何创建一个简单的自定义 WebPart 控件，用于访问 Web 部件控件集的功能。 若要运行代码示例，必须编译此源代码。 可以显式编译它，并将生成的程序集放入网站的 Bin 文件夹或全局程序集缓存中。 或者，可以将源代码放入站点的“App_Code”文件夹中，并在运行时动态编译源代码。 此代码示例假定将源代码编译为程序集，将其放在 Web 应用程序的 Bin 子文件夹中，并使用网页中的 指令引用程序集 Register 。 有关演示这两种编译方法的演练，请参阅 演练：开发和使用自定义 Web 服务器控件。

using System;
using System.Security.Permissions;
using System.Web;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;

namespace Samples.AspNet.CS.Controls
{
  [AspNetHostingPermission(SecurityAction.Demand, 
    Level=AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand, 
    Level=AspNetHostingPermissionLevel.Minimal)]
  public class TextDisplayWebPart : WebPart
  {
    private String _contentText = null;
    TextBox input;
    Label DisplayContent;

    public TextDisplayWebPart()
    {
      this.AllowClose = false;
    }

    [Personalizable(), WebBrowsable]
    public String ContentText
    {
      get { return _contentText; }
      set { _contentText = value; }
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();
      DisplayContent = new Label();
      DisplayContent.BackColor = 
        System.Drawing.Color.LightBlue;
      DisplayContent.Text = this.ContentText;
      this.Controls.Add(DisplayContent);
      input = new TextBox();
      this.Controls.Add(input);
      Button update = new Button();
      update.Text = "Set Label Content";
      update.Click += new EventHandler(this.submit_Click);
      this.Controls.Add(update);
      ChildControlsCreated = true;
    }

    private void submit_Click(object sender, EventArgs e)
    {
      // Update the label string.
      if (!string.IsNullOrEmpty(input.Text))
      {
        _contentText = input.Text + @"<br />";
        input.Text = String.Empty;
        DisplayContent.Text = this.ContentText;
      }
    }
  }
}

Imports System.Security.Permissions
Imports System.Web
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts

Namespace Samples.AspNet.VB.Controls

<AspNetHostingPermission(SecurityAction.Demand, _
  Level := AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
  Level := AspNetHostingPermissionLevel.Minimal)> _
Public Class TextDisplayWebPart
    Inherits WebPart
    Private _contentText As String = Nothing
    Private input As TextBox
    Private DisplayContent As Label
    
    
    Public Sub New() 
      Me.AllowClose = False
    End Sub
    
    <Personalizable(), WebBrowsable()>  _
    Public Property ContentText() As String 
        Get
            Return _contentText
        End Get
        Set
            _contentText = value
        End Set
    End Property
     
    Protected Overrides Sub CreateChildControls() 
        Controls.Clear()
        DisplayContent = New Label()
        DisplayContent.Text = Me.ContentText
        DisplayContent.BackColor = _
          System.Drawing.Color.LightBlue
        Me.Controls.Add(DisplayContent)
        input = New TextBox()
        Me.Controls.Add(input)
        Dim update As New Button()
        update.Text = "Set Label Content"
        AddHandler update.Click, AddressOf Me.submit_Click
        Me.Controls.Add(update)
        ChildControlsCreated = True
    
    End Sub
    
    
    Private Sub submit_Click(ByVal sender As Object, _
                             ByVal e As EventArgs) 
        ' Update the label string.
        If input.Text <> String.Empty Then
            _contentText = input.Text & "<br />"
            input.Text = String.Empty
            DisplayContent.Text = Me.ContentText
        End If
    
    End Sub
    
End Class

End Namespace

该示例的第二部分演示如何在 ASP.NET 网页中引用 TextDisplayWebPart 控件。 请注意，许多各种 WebPart 属性都可以以声明方式分配给自定义控件。

<%@ page language="C#" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.CS.Controls" 
             Assembly="TextDisplayWebPartCS"%>

<!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 id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      title="Zone 1"
      PartChromeType="TitleAndBorder">
        <parttitlestyle font-bold="true" ForeColor="#3300cc" />
        <partstyle
          borderwidth="1px"   
          borderstyle="Solid"  
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

<%@ page language="VB" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.VB.Controls" 
             Assembly="TextDisplayWebPartVB"%>

<!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 id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      title="Zone 1"
      PartChromeType="TitleAndBorder">
        <parttitlestyle font-bold="true" ForeColor="#3300cc" />
        <partstyle
          borderwidth="1px"   
          borderstyle="Solid"  
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text Content WebPart" />
        </zonetemplate>
    </asp:webpartzone>
  </form>
</body>
</html>

注解

使用 Web 部件功能创建控件时，有两个基本选项。 可以创建派生自 类的 WebPart 自定义控件，也可以创建或使用其他服务器控件。 现有 ASP.NET 控件、自定义服务器控件和用户控件都可以通过在 (中声明它们或以编程方式将它们添加到) WebPartZone 区域控件来提供完整的 Web 部件功能，从而在运行时将它们与对象一起 GenericWebPart 包装并被视为真正的 WebPart 控件。 有关详细信息，请参阅 类的文档 GenericWebPart 。 为了加快开发速度并最大程度地重用代码，使用现有服务器控件可能是一个不错的选择。 为了最大程度地以编程方式控制控件的行为和 Web 部件功能，创建从 WebPart 类继承的自定义控件通常是最佳选择。

抽象 WebPart 类继承自基 Part 控件，并为所有 WebPart 控件提供基本元素。 类包括一组影响 UI 外观的通用属性。 AllowClose、AllowConnect、AllowEdit、AllowHide、 AllowMinimize和 AllowZoneChange 属性各自指定是否允许 Web 应用程序的用户按照给定属性名称指示的方式与部件控件交互。 CatalogIconImageUrl、ChromeState、ChromeType、Description、Height、HelpUrl、、Hidden、TitleTitleIconImageUrlTitleUrl、、 和 Width 属性确定控件的大小、可见性、外观和支持内容 (，例如标题和说明) 。WebPart

控件与其 Web 部件控件集中上下文的关系 WebPart 由属性确定，这些 WebPartManager属性包含对控件关联 WebPartManager 对象的引用，以及 Zone引用 WebZone 包含控件的 。 每页只能有一个 WebPartManager 控件，并且控件的每个实例 WebPart 一次只能驻留在一个 WebZone 控件内。

其他几个重要属性会影响控件的独特功能 WebPart 。 属性 AuthorizationFilter 允许开发人员设置可在运行时用作筛选器的任意字符串，以确定控件是否添加到页面。 属性与角色管理等功能一起使用时， AuthorizationFilter 提供了一种有用的机制，用于基于定义的用户角色创建视图。 属性 ExportMode 指示在导出期间，是导出控件上的所有可用属性数据，还是仅导出非敏感数据。 这样，出于安全目的，开发人员就可以区分敏感数据数据和非敏感数据。 属性 WebBrowsableObject 返回对控件实例的 WebPart 引用，以便 EditorPart 控件可以在页面处于编辑模式时对其进行编辑。 最后，有几个属性指示控件相对于页面其余部分的状态。 属性 IsClosed 指示控件是 (关闭并因此添加到 PageCatalogPart 对象) ，还是该控件在页面上处于打开状态且可用。 属性 IsShared 指示控件是共享控件 (还是特定于用户的控件) ，这意味着该控件对网页的所有用户都可见。 属性IsStandalone指示控件当前是否包含在派生区域 (（如 WebPartZone) ） 中WebPartZoneBase。 值 false 指示控件位于区域中，因此具有完整的 Web 部件功能。 属性 IsStatic 指示控件是静态的还是动态的。 静态控件在网页的标记中声明，而动态控件则以编程方式添加。

类 WebPart 还提供了几种方法，用于确定控件生命周期中不同点发生的情况。 例如， OnConnectModeChanged 可以在派生类中重写 和 OnEditModeChanged 方法，以便在与每个方法名称相对应的事件期间对控件内容呈现提供编程控制。

派生自 WebPart 的类可以将 对象添加到WebPartVerb集合。Verbs 谓词呈现在谓词菜单中，该菜单显示在控件的 WebPart 标题栏中。 WebPartVerb 对象为常见用户操作（例如隐藏或最小化控件或显示帮助）提供简单的 UI 元素。

方法 CreateEditorParts 创建与控件关联的任何自定义 EditorPart 控件的 WebPart 集合。 开发人员可以重写此方法，以便它创建专门用于编辑其控件的 WebPart 自定义控件。 当用户单击控件上的 WebPart 编辑谓词时，将调用 方法。

构造函数

属性

方法

事件

显式接口实现

扩展方法

适用于

另请参阅

• GenericWebPart
• Web 部件控件集概述
• ASP.NET Web 部件概述
• Web 部件个性化概述
• ASP.NET Web 部件控件