WebPartManager.DeleteWebPart(WebPart) Méthode

Référence

Définition

Espace de noms:: System.Web.UI.WebControls.WebParts

Assembly:: System.Web.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Supprime définitivement une instance dynamique d'un contrôle WebPart d'une page 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)

Paramètres

webPart: WebPart

Contrôle serveur à supprimer.

Exemples

L'exemple de code suivant illustre l'utilisation de la méthode DeleteWebPart. La première fois que le bouton Ajouter un calendrier est cliqué, le code du gestionnaire d’événements crée un Calendar contrôle et l’ajoute à une zone en tant qu’objet GenericWebPart . Étant donné que le contrôle est ajouté par programmation, il s’agit d’un contrôle dynamique et peut donc être supprimé. Lorsqu’un utilisateur clique sur le bouton Supprimer le calendrier , le code garantit que le contrôle existe, puis le supprime en appelant la DeleteWebPart méthode.

<%@ 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>

Remarques

La DeleteWebPart méthode supprime définitivement le contrôle représenté par le webPart paramètre d’une page. Contrairement à un contrôle fermé, qui est ajouté au contrôle et peut être ajouté à la PageCatalogPart page, une instance de contrôle supprimée ne peut jamais être ajoutée à la page.

Notes

Comme implémenté par le jeu de contrôles composants WebPart, la possibilité pour les utilisateurs de supprimer un contrôle dynamique WebPart dépend de l’utilisateur et de l’étendue de personnalisation dans laquelle le contrôle a été ajouté à une page. Si le contrôle est ajouté lorsque la page est dans une étendue partagée (par un utilisateur disposant d’autorisations), le contrôle ne peut pas être supprimé par des utilisateurs individuels lorsque la page se trouve dans l’étendue de l’utilisateur.

Seuls les contrôles dynamiques peuvent être supprimés. Les contrôles dynamiques sont ajoutés à une page par programmation ou par les utilisateurs qui ajoutent des contrôles à partir d’un catalogue. Les contrôles statiques sont ajoutés à une page de manière déclarative au format de balisage ou de persistance. Étant donné que les balises déclaratives sont présentes définitivement dans le balisage, les contrôles statiques ne peuvent jamais être supprimés, mais ils peuvent être fermés et rouverts.

S’applique à