WebPartManager.DeleteWebPart(WebPart) Método

Referência

Definição

Namespace:: System.Web.UI.WebControls.WebParts

Assembly:: System.Web.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Remove permanentemente uma instância dinâmica de um controle WebPart de uma página da Web.

public:
 void DeleteWebPart(System::Web::UI::WebControls::WebParts::WebPart ^ webPart);

public void DeleteWebPart (System.Web.UI.WebControls.WebParts.WebPart webPart);

member this.DeleteWebPart : System.Web.UI.WebControls.WebParts.WebPart -> unit

Public Sub DeleteWebPart (webPart As WebPart)

Parâmetros

webPart: WebPart

O controle de servidor a ser excluído.

Exemplos

O exemplo de código a seguir demonstra como usar o DeleteWebPart método. Na primeira vez em que o botão Adicionar Calendário é clicado, o código no manipulador de eventos cria um Calendar controle e o adiciona a uma zona como um GenericWebPart objeto. Como o controle é adicionado programaticamente, ele é um controle dinâmico e, portanto, pode ser excluído. Quando um usuário clica no botão Excluir Calendário , o código garante que o controle exista e, em seguida, o exclui chamando o DeleteWebPart 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>

Comentários

O DeleteWebPart método remove permanentemente o controle representado pelo webPart parâmetro de uma página. Ao contrário de um controle fechado, que é adicionado ao PageCatalogPart controle e pode ser adicionado de volta à página, uma instância de controle excluída nunca pode ser adicionada novamente à página.

Observação

Conforme implementado pelo conjunto de controle Web Parts, a capacidade dos usuários de excluir um controle dinâmico WebPart depende do usuário e do escopo de personalização no qual o controle foi adicionado a uma página. Se o controle for adicionado quando a página estiver no escopo compartilhado (por um usuário que tem permissões), o controle não poderá ser excluído por usuários individuais quando a página estiver no escopo do usuário.

Somente controles dinâmicos podem ser excluídos. Os controles dinâmicos são adicionados a uma página programaticamente ou por usuários que adicionam controles de um catálogo. Controles estáticos são adicionados a uma página declarativamente no formato de marcação ou persistência. Como as marcas declarativas estão permanentemente presentes na marcação, os controles estáticos nunca podem ser excluídos, mas podem ser fechados e reabertos.

Aplica-se a