WebPartManager.AddWebPart(WebPart, WebPartZoneBase, Int32) Método

  • Referencia

Definición

Espacio de nombres:
System.Web.UI.WebControls.WebParts
Ensamblado:
System.Web.dll

Proporciona el método de programación estándar para agregar controles WebPart a una página Web.

public:
 System::Web::UI::WebControls::WebParts::WebPart ^ AddWebPart(System::Web::UI::WebControls::WebParts::WebPart ^ webPart, System::Web::UI::WebControls::WebParts::WebPartZoneBase ^ zone, int zoneIndex);
public System.Web.UI.WebControls.WebParts.WebPart AddWebPart (System.Web.UI.WebControls.WebParts.WebPart webPart, System.Web.UI.WebControls.WebParts.WebPartZoneBase zone, int zoneIndex);
member this.AddWebPart : System.Web.UI.WebControls.WebParts.WebPart * System.Web.UI.WebControls.WebParts.WebPartZoneBase * int -> System.Web.UI.WebControls.WebParts.WebPart
Public Function AddWebPart (webPart As WebPart, zone As WebPartZoneBase, zoneIndex As Integer) As WebPart

Parámetros

webPart
WebPart

WebPart (o control de servidor o de usuario) que se va a agregar a una página web o que se va a abrir en una página.

zone
WebPartZoneBase

Zona WebPartZoneBase a la que se va a agregar webPart.

zoneIndex
Int32

Entero que representa la posición ordinal que webPart ocupa en zone respecto a otros controles en zone.

Devoluciones

WebPart

Control WebPart que se ha agregado a la página.

Excepciones

ArgumentNullException

webPart es null.

O bien

zone es null.

ArgumentException

zone no está registrado en la colección de zonas del control WebPartManager.

o bien

webPart ya está en zone.

ArgumentOutOfRangeException

El valor de zoneIndex es menor que cero.

Ejemplos

En el ejemplo de código siguiente se muestra el uso del AddWebPart método para agregar un control de servidor mediante programación a una página. El marcado de página contiene un elemento vacío <asp:webpartzone> y un <asp:webpartmanager> elemento . La primera vez que se hace clic en el botón Agregar calendario , el código del controlador de eventos crea un Calendar control y lo agrega a una zona como un GenericWebPart objeto, llamando al AddWebPart método .

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

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

  protected void Button2_Click(object sender, EventArgs e)
  {
    WebPartManager mgr = WebPartManager1;
    Calendar cal = new Calendar();
    cal.ID = "cal1";
    GenericWebPart calWebPart = mgr.CreateWebPart(cal);
    mgr.AddWebPart(calWebPart, WebPartZone1, 1);
  }

  protected void Button1_Click(object sender, EventArgs e)
  {
    if (WebPartZone1.WebParts.Count > 1)
    {
      WebPart cal = WebPartZone1.WebParts[1];
      if (cal.Controls[0].GetType().Name == "Calendar" 
        && cal != null)
        WebPartManager1.DeleteWebPart(cal);
    }

  }
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>Adding a Server Control</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:WebPartManager ID="WebPartManager1" 
        runat="server" />
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <asp:BulletedList  
            DisplayMode="HyperLink" 
            ID="BulletedList1" 
            runat="server"
            Title="My Links">
            <asp:ListItem Value="http://www.microsoft.com">
            Microsoft
            </asp:ListItem>
            <asp:ListItem Value="http://www.msn.com">
            MSN
            </asp:ListItem>
            <asp:ListItem Value="http://www.contoso.com">
            Contoso Corp.
            </asp:ListItem>
          </asp:BulletedList>
        </ZoneTemplate>
      </asp:WebPartZone>
      <asp:Button ID="Button1" runat="server" 
        Text="Delete Calendar" 
        OnClick="Button1_Click" />
      <asp:Button ID="Button2" runat="server" 
        Text="Add Calendar" 
        OnClick="Button2_Click" />
    </div>
    </form>
</body>
</html>

<%@ Page Language="vb" %>

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

  Protected Sub Button2_Click(ByVal sender As Object, _
    ByVal e As System.EventArgs)
    Dim mgr As WebPartManager = WebPartManager1
    Dim cal As New Calendar()
    cal.ID = "cal1"
    Dim calWebPart As GenericWebPart = mgr.CreateWebPart(cal)
    mgr.AddWebPart(calWebPart, WebPartZone1, 1)
  End Sub

  Protected Sub Button1_Click(ByVal sender As Object, _
    ByVal e As System.EventArgs)

    If WebPartZone1.WebParts.Count > 1 Then
      Dim cal As WebPart = WebPartZone1.WebParts(1)
      If cal.Controls(0).GetType().Name = "Calendar" AndAlso _
        cal IsNot Nothing Then
        WebPartManager1.DeleteWebPart(cal)
      End If
    End If
  End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>Adding a Server Control</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:WebPartManager ID="WebPartManager1" 
        runat="server" />
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <asp:BulletedList  
            DisplayMode="HyperLink" 
            ID="BulletedList1" 
            runat="server"
            Title="My Links">
            <asp:ListItem Value="http://www.microsoft.com">
            Microsoft
            </asp:ListItem>
            <asp:ListItem Value="http://www.msn.com">
            MSN
            </asp:ListItem>
            <asp:ListItem Value="http://www.contoso.com">
            Contoso Corp.
            </asp:ListItem>
          </asp:BulletedList>
        </ZoneTemplate>
      </asp:WebPartZone>
      <asp:Button ID="Button1" runat="server" 
        Text="Delete Calendar" 
        OnClick="Button1_Click" />
      <asp:Button ID="Button2" runat="server" 
        Text="Add Calendar" 
        OnClick="Button2_Click" />
    </div>
    </form>
</body>
</html>

Comentarios

El AddWebPart método se usa tanto para agregar nuevos controles dinámicos WebPart a una página como para volver a abrir controles estáticos o dinámicos que se han cerrado previamente en una página. Cuando se llama al método para agregar un nuevo control, realmente crea una copia del control al que se hace referencia en el webPart parámetro . Se genera un nuevo identificador para la copia del control, por lo que los desarrolladores deben hacer referencia al WebPart control devuelto desde el método para obtener el nuevo valor de identificador. Cuando se llama al método para volver a abrir un control cerrado previamente, devuelve una referencia directa al control al que hace referencia el webPart parámetro .

Importante

Siempre debe usar el AddWebPart método , en lugar del Add método de la colección de controles a los que hace referencia la WebPartManager.Controls propiedad , para agregar WebPart controles mediante programación a la página, ya que el uso del Add método produce una excepción. Para agregar un control que no sea un WebPart control (es decir, un control de servidor que se encapsulará con un GenericWebPart control en tiempo de ejecución), primero debe llamar al CreateWebPart método para crear el control y, a continuación, llamar al AddWebPart método para agregar el control. Para ver una demostración de este enfoque, consulte la sección Ejemplo.

Se aplica a

Consulte también