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

Définition

Fournit la méthode par programme standard pour ajouter des contrôles WebPart à une page Web.Provides the standard programmatic method for adding WebPart controls to a Web page.

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

Paramètres

webPart
WebPart

WebPart (ou contrôle serveur ou utilisateur) à ajouter à une page Web ou à ouvrir sur une page.The WebPart (or server or user control) to be added to a Web page or opened on a page.

zone
WebPartZoneBase

WebPartZoneBase auquel webPart est ajouté.The WebPartZoneBase that webPart is being added to.

zoneIndex
Int32

Entier qui représente la position ordinale occupée par webPart dans zone par rapport à d'autres contrôles dans zone.An integer that represents the ordinal position that webPart occupies in zone, relative to other controls in zone.

Retours

Contrôle WebPart qui a été ajouté à la page.A WebPart control that was added to the page.

Exceptions

webPart a la valeur null.webPart is null.

- ou --or- zone a la valeur null.zone is null.

zone n'est pas enregistrée dans la collection de zones du contrôle WebPartManager.zone is not registered in the WebPartManager control's collection of zones.

- ou --or- webPart est déjà dans zone.webPart is already in zone.

La valeur de zoneIndex est inférieure à zéro.The value of zoneIndex is less than zero.

Exemples

L’exemple de code suivant illustre l’utilisation AddWebPart de la méthode pour ajouter un contrôle serveur par programmation à une page.The following code example demonstrates use of the AddWebPart method to add a server control programmatically to a page. Le balisage de page contient <asp:webpartzone> un élément vide et <asp:webpartmanager> un élément.The page markup contains an empty <asp:webpartzone> element, and an <asp:webpartmanager> element. La première fois que l’utilisateur clique sur le bouton Ajouter un calendrier , le code du gestionnaire Calendar d’événements crée un contrôle et l’ajoute à une GenericWebPart zone sous la forme AddWebPart d’un objet, en appelant la méthode.The first time the Add Calendar button is clicked, the code in the event handler creates a Calendar control, and adds it to a zone as a GenericWebPart object, calling the AddWebPart method.

<%@ 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 AddWebPart méthode est utilisée à la fois pour ajouter WebPart de nouveaux contrôles dynamiques à une page et pour rouvrir des contrôles statiques ou dynamiques qui ont été précédemment fermés sur une page.The AddWebPart method is used both to add new dynamic WebPart controls to a page, and to reopen static or dynamic controls that have previously been closed on a page. Quand la méthode est appelée pour ajouter un nouveau contrôle, elle crée en fait une copie du contrôle référencé dans le webPart paramètre.When the method is called to add a new control, it actually creates a copy of the control referenced in the webPart parameter. Un nouvel ID est généré pour la copie du contrôle, de sorte que les développeurs doivent WebPart référencer le contrôle retourné par la méthode pour obtenir la nouvelle valeur d’ID.A new ID is generated for the copy of the control, so developers should reference the WebPart control returned from the method to get the new ID value. Lorsque la méthode est appelée pour rouvrir un contrôle précédemment fermé, elle retourne une référence directe au contrôle référencé par le webPart paramètre.When the method is called to reopen a previously closed control, it returns a direct reference to the control referenced by the webPart parameter.

Important

Vous devez toujours utiliser la AddWebPart méthode, plutôt que la Add méthode de la collection de contrôles référencée par la WebPartManager.Controls propriété, pour ajouter WebPart des contrôles par programmation à la page, car l’utilisation Add de l’onglet la méthode lève une exception.You should always use the AddWebPart method, rather than the Add method of the collection of controls referenced by the WebPartManager.Controls property, to add WebPart controls programmatically to the page, because using the Add method throws an exception. Pour ajouter un contrôle qui n’est pas WebPart un contrôle (en d’autres termes, un contrôle serveur qui sera encapsulé avec GenericWebPart un contrôle au moment de l’exécution), vous devez CreateWebPart d’abord appeler la méthode pour créer le contrôle, AddWebPart puis appeler la méthode pour ajouter contrôle.To add a control that is not a WebPart control (in other words, a server control that will be wrapped with a GenericWebPart control at run time), you should first call the CreateWebPart method to create the control, and then call the AddWebPart method to add the control. Pour une démonstration de cette approche, consultez la section exemple.For a demonstration of this approach, see the Example section.

S’applique à

Voir aussi