WebPartManager Classe

Définition

public ref class WebPartManager : System::Web::UI::Control, System::Web::UI::INamingContainer, System::Web::UI::WebControls::WebParts::IPersonalizable

[System.ComponentModel.Bindable(false)]
public class WebPartManager : System.Web.UI.Control, System.Web.UI.INamingContainer, System.Web.UI.WebControls.WebParts.IPersonalizable

[<System.ComponentModel.Bindable(false)>]
type WebPartManager = class
    inherit Control
    interface INamingContainer
    interface IPersonalizable

Public Class WebPartManager
Inherits Control
Implements INamingContainer, IPersonalizable

Héritage

Object

Control

WebPartManager

Attributs

BindableAttribute

Implémente

INamingContainer IPersonalizable

Exemples

L’exemple de code suivant illustre l’utilisation déclarative et programmatique du WebPartManager contrôle.

L’exemple de code comporte quatre parties :

• Contrôle utilisateur qui vous permet de modifier les modes d’affichage sur une page de composants WebPart.

• Page Web qui contient deux contrôles personnalisés WebPart qui peuvent être connectés et un <asp:webpartmanager> élément .

• Fichier de code source qui contient deux contrôles personnalisés WebPart et une interface personnalisée.

• Explication du fonctionnement de l’exemple dans un navigateur.

Le contrôle utilisateur dispose d’un contrôle de liste déroulante qui affiche les modes d’affichage possibles sur une page, compte tenu des contrôles WebPart présents sur la page. Dans la page Web de cet exemple de code, ce contrôle utilisateur est déclaré juste en dessous de l’élément WebPartManager dans le balisage de la page, et il existe une Register directive en haut de la page Web pour inscrire le contrôle. Pour plus d’informations sur les modes d’affichage et une description du code source dans ce contrôle, consultez Procédure pas à pas : modification des modes d’affichage sur une page de composants WebPart.

<%@ control language="C#" classname="DisplayModeMenuCS"%>
<script runat="server">
  
 // Use a field to reference the current WebPartManager.
  WebPartManager _manager;

  void Page_Init(object sender, EventArgs e)
  {
    Page.InitComplete += new EventHandler(InitComplete);
  }  

  void InitComplete(object sender, System.EventArgs e)
  {
    _manager = WebPartManager.GetCurrentWebPartManager(Page);

    String browseModeName = WebPartManager.BrowseDisplayMode.Name;

    // Fill the dropdown with the names of supported display modes.
    foreach (WebPartDisplayMode mode in _manager.SupportedDisplayModes)
    {
      String modeName = mode.Name;
      // Make sure a mode is enabled before adding it.
      if (mode.IsEnabled(_manager))
      {
        ListItem item = new ListItem(modeName, modeName);
        DisplayModeDropdown.Items.Add(item);
      }
    }

    // If shared scope is allowed for this user, display the scope-switching
    // UI and select the appropriate radio button for the current user scope.
    if (_manager.Personalization.CanEnterSharedScope)
    {
      Panel2.Visible = true;
      if (_manager.Personalization.Scope == PersonalizationScope.User)
        RadioButton1.Checked = true;
      else
        RadioButton2.Checked = true;
    }
    
  }
 
  // Change the page to the selected display mode.
  void DisplayModeDropdown_SelectedIndexChanged(object sender, EventArgs e)
  {
    String selectedMode = DisplayModeDropdown.SelectedValue;

    WebPartDisplayMode mode = _manager.SupportedDisplayModes[selectedMode];
    if (mode != null)
      _manager.DisplayMode = mode;
  }

  // Set the selected item equal to the current display mode.
  void Page_PreRender(object sender, EventArgs e)
  {
    ListItemCollection items = DisplayModeDropdown.Items;
    int selectedIndex = 
      items.IndexOf(items.FindByText(_manager.DisplayMode.Name));
    DisplayModeDropdown.SelectedIndex = selectedIndex;
  }

  // Reset all of a user's personalization data for the page.
  protected void LinkButton1_Click(object sender, EventArgs e)
  {
    _manager.Personalization.ResetPersonalizationState();
  }

  // If not in User personalization scope, toggle into it.
  protected void RadioButton1_CheckedChanged(object sender, EventArgs e)
  {
    if (_manager.Personalization.Scope == PersonalizationScope.Shared)
      _manager.Personalization.ToggleScope();
  }

  // If not in Shared scope, and if user is allowed, toggle the scope.
  protected void RadioButton2_CheckedChanged(object sender, EventArgs e)
  {
    if (_manager.Personalization.CanEnterSharedScope && 
        _manager.Personalization.Scope == PersonalizationScope.User)
      _manager.Personalization.ToggleScope();
  }
</script>
<div>
  <asp:Panel ID="Panel1" runat="server" 
    Borderwidth="1" 
    Width="230" 
    BackColor="lightgray"
    Font-Names="Verdana, Arial, Sans Serif" >
    <asp:Label ID="Label1" runat="server" 
      Text=" Display Mode" 
      Font-Bold="true"
      Font-Size="8"
      Width="120" 
      AssociatedControlID="DisplayModeDropdown"/>
    <asp:DropDownList ID="DisplayModeDropdown" runat="server"  
      AutoPostBack="true" 
      Width="120"
      OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
    <asp:LinkButton ID="LinkButton1" runat="server"
      Text="Reset User State" 
      ToolTip="Reset the current user's personalization data for the page."
      Font-Size="8" 
      OnClick="LinkButton1_Click" />
    <asp:Panel ID="Panel2" runat="server" 
      GroupingText="Personalization Scope"
      Font-Bold="true"
      Font-Size="8" 
      Visible="false" >
      <asp:RadioButton ID="RadioButton1" runat="server" 
        Text="User" 
        AutoPostBack="true"
        GroupName="Scope" OnCheckedChanged="RadioButton1_CheckedChanged" />
      <asp:RadioButton ID="RadioButton2" runat="server" 
        Text="Shared" 
        AutoPostBack="true"
        GroupName="Scope" 
        OnCheckedChanged="RadioButton2_CheckedChanged" />
    </asp:Panel>
  </asp:Panel>
</div>

<%@ control language="vb" classname="DisplayModeMenuVB"%>
<script runat="server">
  ' Use a field to reference the current WebPartManager.
  Dim _manager As WebPartManager

  Sub Page_Init(ByVal sender As Object, ByVal e As EventArgs)
    AddHandler Page.InitComplete, AddressOf InitComplete
  End Sub

  Sub InitComplete(ByVal sender As Object, ByVal e As System.EventArgs)
    _manager = WebPartManager.GetCurrentWebPartManager(Page)
      
    Dim browseModeName As String = WebPartManager.BrowseDisplayMode.Name
      
    ' Fill the dropdown with the names of supported display modes.
    Dim mode As WebPartDisplayMode
    For Each mode In _manager.SupportedDisplayModes
      Dim modeName As String = mode.Name
      ' Make sure a mode is enabled before adding it.
      If mode.IsEnabled(_manager) Then
        Dim item As New ListItem(modeName, modeName)
        DisplayModeDropdown.Items.Add(item)
      End If
    Next mode
      
    ' If shared scope is allowed for this user, display the scope-switching
    ' UI and select the appropriate radio button for the current user scope.
    If _manager.Personalization.CanEnterSharedScope Then
      Panel2.Visible = True
      If _manager.Personalization.Scope = PersonalizationScope.User Then
        RadioButton1.Checked = True
      Else
        RadioButton2.Checked = True
      End If
    End If
   
  End Sub

  ' Change the page to the selected display mode.
  Sub DisplayModeDropdown_SelectedIndexChanged(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    Dim selectedMode As String = DisplayModeDropdown.SelectedValue   
    Dim mode As WebPartDisplayMode = _
      _manager.SupportedDisplayModes(selectedMode)
    If Not (mode Is Nothing) Then
      _manager.DisplayMode = mode
    End If

  End Sub
   
  ' Set the selected item equal to the current display mode.
  Sub Page_PreRender(ByVal sender As Object, ByVal e As EventArgs)
    Dim items As ListItemCollection = DisplayModeDropdown.Items
    Dim selectedIndex As Integer = _
      items.IndexOf(items.FindByText(_manager.DisplayMode.Name))
    DisplayModeDropdown.SelectedIndex = selectedIndex

  End Sub

  ' Reset all of a user's personalization data for the page.
  Protected Sub LinkButton1_Click(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    _manager.Personalization.ResetPersonalizationState()
    
  End Sub

  ' If not in User personalization scope, toggle into it.
  Protected Sub RadioButton1_CheckedChanged(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    If _manager.Personalization.Scope = PersonalizationScope.Shared Then
      _manager.Personalization.ToggleScope()
    End If

  End Sub
   
  ' If not in Shared scope, and if user is allowed, toggle the scope.
  Protected Sub RadioButton2_CheckedChanged(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    If _manager.Personalization.CanEnterSharedScope AndAlso _
      _manager.Personalization.Scope = PersonalizationScope.User Then
      _manager.Personalization.ToggleScope()
    End If

  End Sub

</script>
<div>
  <asp:Panel ID="Panel1" runat="server" 
    Borderwidth="1" 
    Width="230" 
    BackColor="lightgray"
    Font-Names="Verdana, Arial, Sans Serif" >
    <asp:Label ID="Label1" runat="server" 
      Text=" Display Mode" 
      Font-Bold="true"
      Font-Size="8"
      Width="120" 
      AssociatedControlID="DisplayModeDropdown"/>
    <asp:DropDownList ID="DisplayModeDropdown" runat="server"  
      AutoPostBack="true" 
      Width="120"
      OnSelectedIndexChanged="DisplayModeDropdown_SelectedIndexChanged" />
    <asp:LinkButton ID="LinkButton1" runat="server"
      Text="Reset User State" 
      ToolTip="Reset the current user's personalization data for the page."
      Font-Size="8" 
      OnClick="LinkButton1_Click" />
    <asp:Panel ID="Panel2" runat="server" 
      GroupingText="Personalization Scope"
      Font-Bold="true"
      Font-Size="8" 
      Visible="false" >
      <asp:RadioButton ID="RadioButton1" runat="server" 
        Text="User" 
        AutoPostBack="true"
        GroupName="Scope" OnCheckedChanged="RadioButton1_CheckedChanged" />
      <asp:RadioButton ID="RadioButton2" runat="server" 
        Text="Shared" 
        AutoPostBack="true"
        GroupName="Scope" 
        OnCheckedChanged="RadioButton2_CheckedChanged" />
    </asp:Panel>
  </asp:Panel>
</div>

Le balisage déclaratif de la page Web contient des Register directives pour le contrôle utilisateur et les contrôles personnalisés. Il existe un <asp:webpartmanager> élément, un <asp:webpartzone> élément pour contenir les contrôles personnalisés et un <asp:connectionszone> élément . La page contient également du code inline qui gère les événements liés à la connexion pour le WebPartManager contrôle ; vous pouvez voir l’effet de ce code lorsque vous connectez et déconnectez des contrôles.

<%@ Page Language="C#" %>
<%@ register TagPrefix="uc1" 
  TagName="DisplayModeMenuCS" 
  Src="DisplayModeMenuCS.ascx" %>
<%@ register tagprefix="aspSample" 
  Namespace="Samples.AspNet.CS.Controls" 
  Assembly="ConnectionSampleCS" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
 
  private void UpdateLabelData(int wpCount, int connCount)
  {
    Label1.Text = "WebPart Control Count:  " + wpCount.ToString();
    Label2.Text = "Connections Count: " + connCount.ToString();
  }

  protected void WebPartManager1_WebPartsConnected(object sender, WebPartConnectionsEventArgs e)
  {
    UpdateLabelData(WebPartManager1.WebParts.Count,
      WebPartManager1.Connections.Count);
  }

  protected void WebPartManager1_WebPartsDisconnected(object sender, WebPartConnectionsEventArgs e)
  {
    UpdateLabelData(WebPartManager1.WebParts.Count,
      WebPartManager1.Connections.Count);
  }
  
</script>

<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">
      <!-- Reference the WebPartManager control. -->
      <asp:WebPartManager ID="WebPartManager1" runat="server"  
        OnWebPartsConnected="WebPartManager1_WebPartsConnected" 
        OnWebPartsDisconnected="WebPartManager1_WebPartsDisconnected" />
    <div>
      <uc1:DisplayModeMenuCS ID="displaymode1" runat="server" />
      <!-- Reference consumer and provider controls in a zone. -->
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <aspSample:ZipCodeWebPart ID="zip1" 
            runat="server" 
            Title="Zip Code Control"/>
          <aspSample:WeatherWebPart ID="weather1" 
            runat="server" 
            Title="Weather Control" />
        </ZoneTemplate>
      </asp:WebPartZone>
      <hr />
      <asp:Label ID="Label1" runat="server" Text=""></asp:Label>
      <br />
      <asp:Label ID="Label2" runat="server" Text=""></asp:Label>
      <!-- Add a ConnectionsZone so users can connect controls. -->
      <asp:ConnectionsZone ID="ConnectionsZone1" runat="server" />
    </div>
    </form>
</body>
</html>

<%@ Page Language="vb" %>
<%@ register TagPrefix="uc1" 
  TagName="DisplayModeMenuVB" 
  Src="DisplayModeMenuVB.ascx" %>
<%@ register tagprefix="aspSample" 
  Namespace="Samples.AspNet.VB.Controls" 
  Assembly="ConnectionSampleVB" %>

<!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 WebPartManager1_WebPartsConnected( _
    ByVal sender As Object, _
    ByVal e As System.Web.UI.WebControls.WebParts.WebPartConnectionsEventArgs)
    
    UpdateLabelData(WebPartManager1.WebParts.Count, _
      WebPartManager1.Connections.Count)
    
  End Sub

  Protected Sub WebPartManager1_WebPartsDisconnected( _
    ByVal sender As Object, _
    ByVal e As System.Web.UI.WebControls.WebParts.WebPartConnectionsEventArgs)
    
    UpdateLabelData(WebPartManager1.WebParts.Count, _
      WebPartManager1.Connections.Count)
    
  End Sub
  
  Private Sub UpdateLabelData(ByVal wpCount As Integer, _
    ByVal connCount As Integer)
    
    Label1.Text = "WebPart Control Count:  " & wpCount.ToString()
    Label2.Text = "Connections Count: " & connCount.ToString()
    
  End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
      <!-- Reference the WebPartManager control. -->
      <asp:WebPartManager ID="WebPartManager1" runat="server" OnWebPartsConnected="WebPartManager1_WebPartsConnected" OnWebPartsDisconnected="WebPartManager1_WebPartsDisconnected" />
    <div>
      <uc1:DisplayModeMenuVB ID="displaymode1" runat="server" />
      <!-- Reference consumer and provider controls in a zone. -->
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <aspSample:ZipCodeWebPart ID="zip1" 
            runat="server" 
            Title="Zip Code Control"/>
          <aspSample:WeatherWebPart ID="weather1" 
            runat="server" 
            Title="Weather Control" />
        </ZoneTemplate>
      </asp:WebPartZone>
      <hr />
      <asp:Label ID="Label1" runat="server" Text=""></asp:Label>
      <br />
      <asp:Label ID="Label2" runat="server" Text=""></asp:Label>
      <!-- Add a ConnectionsZone so users can connect controls. -->
      <asp:ConnectionsZone ID="ConnectionsZone1" runat="server" />
    </div>
    </form>
</body>
</html>

La troisième partie de l’exemple est le code source des contrôles. Notez qu’il existe une interface nommée IZipCode, et cette interface est implémentée dans la ZipCodeWebPart classe . Cette classe a une méthode de rappel spéciale nommée ProvideIZipCode qui sert de fournisseur. L’autre type, nommé WeatherWebPart, est également implémenté avec une méthode spéciale nommée GetIZipCode, qui permet au contrôle d’agir en tant que consommateur de l’autre contrôle.

Pour que l’exemple de code s’exécute, vous devez compiler ce code source. Vous pouvez le compiler explicitement et placer l’assembly résultant dans le dossier Bin de votre site web ou dans le Global Assembly Cache. Vous pouvez également placer le code source dans le dossier App_Code de votre site, où il sera compilé dynamiquement au moment de l’exécution. Cet exemple de code suppose que vous avez compilé la source dans un assembly et que la Register directive dans la page Web fait référence au nom de l’assembly. Pour obtenir une procédure pas à pas qui montre comment compiler, consultez Procédure pas à pas : développement et utilisation d’un contrôle serveur Web personnalisé.

namespace Samples.AspNet.CS.Controls
{
  using System;
  using System.Web;
  using System.Web.Security;
  using System.Security.Permissions;
  using System.Web.UI;
  using System.Web.UI.WebControls;
  using System.Web.UI.WebControls.WebParts;

  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public interface IZipCode
  {
    string ZipCode { get; set;}
  }

  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public class ZipCodeWebPart : WebPart, IZipCode
  {
    string zipCodeText = String.Empty;
    TextBox input;
    Button send;

    public ZipCodeWebPart()
    {
    }

    // Make the implemented property personalizable to save 
    // the Zip Code between browser sessions.
    [Personalizable()]
    public virtual string ZipCode
    {
      get { return zipCodeText; }
      set { zipCodeText = value; }
    }

    // This is the callback method that returns the provider.
    [ConnectionProvider("Zip Code")]
    public IZipCode ProvideIZipCode()
    {
      return this;
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();
      input = new TextBox();
      this.Controls.Add(input);
      send = new Button();
      send.Text = "Enter 5-digit Zip Code";
      send.Click += new EventHandler(this.submit_Click);
      this.Controls.Add(send);
    }

    private void submit_Click(object sender, EventArgs e)
    {
      if (!string.IsNullOrEmpty(input.Text))
      {
        zipCodeText = Page.Server.HtmlEncode(input.Text);
        input.Text = String.Empty;
      }
    }
  }

  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public class WeatherWebPart : WebPart
  {
    private IZipCode _provider;
    string _zipSearch;
    Label DisplayContent;

    // This method is identified by the ConnectionConsumer 
    // attribute, and is the mechanism for connecting with 
    // the provider. 
    [ConnectionConsumer("Zip Code")]
    public void GetIZipCode(IZipCode Provider)
    {
      _provider = Provider;
    }
    
    protected override void OnPreRender(EventArgs e)
    {
      EnsureChildControls();

      if (this._provider != null)
      {
        _zipSearch = _provider.ZipCode.Trim();
        DisplayContent.Text = "My Zip Code is:  " + _zipSearch;
      }
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();
      DisplayContent = new Label();
      this.Controls.Add(DisplayContent);
    }
  }
}

Imports System.Web
Imports System.Web.Security
Imports System.Security.Permissions
Imports System.Web.UI
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 Interface IZipCode

    Property ZipCode() As String

  End Interface

  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Class ZipCodeWebPart
    Inherits WebPart
    Implements IZipCode
    Private zipCodeText As String = String.Empty
    Private input As TextBox
    Private send As Button

    Public Sub New()
    End Sub

    ' Make the implemented property personalizable to save 
    ' the Zip Code between browser sessions.
    <Personalizable()> _
    Public Property ZipCode() As String _
      Implements IZipCode.ZipCode

      Get
        Return zipCodeText
      End Get
      Set(ByVal value As String)
        zipCodeText = value
      End Set
    End Property

    ' This is the callback method that returns the provider.
    <ConnectionProvider("Zip Code")> _
    Public Function ProvideIZipCode() As IZipCode
      Return Me
    End Function


    Protected Overrides Sub CreateChildControls()
      Controls.Clear()
      input = New TextBox()
      Me.Controls.Add(input)
      send = New Button()
      send.Text = "Enter 5-digit Zip Code"
      AddHandler send.Click, AddressOf Me.submit_Click
      Me.Controls.Add(send)

    End Sub


    Private Sub submit_Click(ByVal sender As Object, _
      ByVal e As EventArgs)

      If input.Text <> String.Empty Then
        zipCodeText = Page.Server.HtmlEncode(input.Text)
        input.Text = String.Empty
      End If

    End Sub

  End Class

  <AspNetHostingPermission(SecurityAction.Demand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  <AspNetHostingPermission(SecurityAction.InheritanceDemand, _
    Level:=AspNetHostingPermissionLevel.Minimal)> _
  Public Class WeatherWebPart
    Inherits WebPart
    Private _provider As IZipCode
    Private _zipSearch As String
    Private DisplayContent As Label

    ' This method is identified by the ConnectionConsumer 
    ' attribute, and is the mechanism for connecting with 
    ' the provider. 
    <ConnectionConsumer("Zip Code")> _
    Public Sub GetIZipCode(ByVal Provider As IZipCode)
      _provider = Provider
    End Sub


    Protected Overrides Sub OnPreRender(ByVal e As EventArgs)
      EnsureChildControls()

      If Not (Me._provider Is Nothing) Then
        _zipSearch = _provider.ZipCode.Trim()
    DisplayContent.Text = "My Zip Code is:  " + _zipSearch
      End If

    End Sub

    Protected Overrides Sub CreateChildControls()
      Controls.Clear()
      DisplayContent = New Label()
      Me.Controls.Add(DisplayContent)

    End Sub

  End Class

End Namespace

Une fois que vous avez chargé la page Web dans un navigateur, cliquez sur le contrôle de liste déroulante Mode d’affichage et sélectionnez Se connecter pour basculer la page en mode connexion. Le mode Connexion utilise l’élément <asp:connectionszone> pour vous permettre de créer des connexions entre les contrôles. En mode connexion, cliquez sur la flèche vers le bas dans la barre de titre du contrôle Code postal pour activer son menu verbes, puis cliquez sur Se connecter. Une fois l’interface utilisateur de connexion affichée, cliquez sur le lien Créer une connexion à un consommateur . Une cellule qui a un contrôle de liste déroulante s’affiche. Sélectionnez Contrôle météo dans la liste déroulante, puis cliquez sur Se connecter pour terminer la connexion des deux contrôles. Cliquez sur Fermer, puis utilisez la liste déroulante Mode d’affichage pour rétablir le mode de navigation normal de la page. Vous pouvez entrer un code postal, et le contrôle consommateur sera mis à jour avec la valeur que vous entrez. Étant donné que la ZipCode propriété a été marquée avec l’attribut Personalizable dans le code source, cette valeur de propriété est conservée dans les sessions de navigateur, ce qui enregistre la valeur entrée par un utilisateur. Un contrôle consommateur plus sophistiqué peut prendre les informations du code postal, rechercher des informations météorologiques basées sur le code et les afficher à un utilisateur.

Remarques

Le WebPartManager contrôle joue le rôle de hub ou de centre de contrôle d’une application WebPart. Il doit y avoir une seuleWebPartManager instance de contrôle sur chaque page qui utilise des contrôles WebPart. Comme pour la plupart des aspects des applications WebPart, le WebPartManager contrôle fonctionne uniquement avec des utilisateurs authentifiés. En outre, ses fonctionnalités fonctionnent presque entièrement avec les contrôles serveur qui résident dans des zones de composants WebPart qui héritent de la WebZone classe . Les contrôles serveur qui résident sur une page en dehors de ces zones peuvent avoir très peu de fonctionnalités webPart ou d’interaction avec le WebPartManager contrôle.

En tant que hub pour les fonctionnalités de composants WebPart sur une page, le WebPartManager contrôle effectue les types de tâches décrits dans le tableau suivant.

La WebPartManager classe a un grand ensemble de propriétés. Conformément au WebPartManager rôle de suivi d’autres contrôles, il possède un certain nombre de propriétés qui référencent des collections de contrôles WebPart ou d’autres objets De composants WebPart spéciaux. Les AvailableTransformerspropriétés , Connections, Controls, DynamicConnectionsDisplayModesSupportedDisplayModes, , WebParts, et Zones sont toutes des collections utilisées par le WebPartManager contrôle pour ses tâches de suivi et d’autres tâches de gestion.

Un autre groupe de propriétés contient des avertissements personnalisables qui s’appliquent dans certains scénarios qui se produisent dans une application de composants WebPart. Il s’agit notamment des CloseProviderWarningDeleteWarningpropriétés , et .ExportSensitiveDataWarning

La WebPartManager classe remplace certaines de ses propriétés héritées de base, qui sont utilisées par de nombreux contrôles serveur Web. Il s’agit notamment des EnableThemingpropriétés , SkinIDet Visible .

Enfin, il existe un groupe de propriétés utiles pour accéder à l’état actuel de l’application. La DisplayMode propriété indique le mode d’affichage actuel dans lequel se trouve une page. La EnableClientScript propriété indique si un contrôle est autorisé à restituer un script côté client, ce qui est pertinent dans les situations où les utilisateurs peuvent avoir des navigateurs avec des fonctionnalités différentes ou désactiver les scripts. La Internals propriété est utile pour référencer une classe d’utilitaire qui contient les appels à un certain nombre de méthodes de composants WebPart importantes utilisées pour les cas d’extensibilité. En masquant les appels à ces méthodes dans une classe distincte (la WebPartManagerInternals classe), l’API de la WebPartManager classe est simplifiée. La Personalization propriété permet d’accéder aux objets de personnalisation qui stockent les paramètres de personnalisation des utilisateurs et conservent ces données dans un stockage permanent. La SelectedWebPart propriété indique quel WebPart contrôle d’une page est actuellement sélectionné par l’utilisateur ou l’application. La IPersonalizable.IsDirty propriété indique si les données de personnalisation personnalisées d’un WebPart contrôle ont été modifiées.

Le WebPartManager contrôle contient cinq modes d’affichage intégrés ou affichages d’une page Web. Les développeurs peuvent étendre cette fonctionnalité, en créant des modes d’affichage personnalisés en étendant des types tels que la WebZone classe ou la ToolZone classe. Les utilisateurs peuvent basculer une page dans les différents modes d’affichage, à condition que le type approprié de contrôles correspondant à un mode d’affichage donné soit présent sur une page.

Les modes d’affichage standard sont représentés par des champs publics dans la WebPartManager classe . Le tableau suivant récapitule les champs et les modes d’affichage auxquels ils font référence. Le mode d’affichage actuel d’une page, comme indiqué ci-dessus, est toujours référencé dans la DisplayMode propriété, et l’ensemble des modes d’affichage possibles sur une page particulière, compte tenu du type de zones présentes sur la page, est contenu dans la SupportedDisplayModes propriété .

Le WebPartManager contrôle contient également un certain nombre d’événements qui sont critiques dans le cycle de vie des pages et contrôles de composants WebPart. Ces événements fournissent un contrôle programmatique précis sur le comportement des contrôles de composants WebPart. La plupart des méthodes se rapportent directement aux WebPart contrôles (ou à d’autres contrôles serveur ou utilisateur placés dans WebPartZoneBase des zones afin qu’ils puissent se comporter comme WebPart des contrôles). Toutefois, quelques événements concernent l’état de la page ou des connexions sur la page. Le tableau suivant répertorie les événements disponibles et récapitule leurs objectifs.

Le WebPartManager contrôle a de nombreuses méthodes pour gérer les pages de composants WebPart. Un grand ensemble de méthodes, non répertoriées ici, sont des méthodes dont le nom prend la forme OnEventName. Ces méthodes déclenchent généralement l’événement associé et fournissent à l’événement un gestionnaire de type WebPartEventHandler. La plupart de ces méthodes peuvent être remplacées par les développeurs qui héritent de la WebPartManager classe . En outre, les développeurs de pages peuvent fournir des gestionnaires personnalisés pour les événements associés à ces méthodes. Par exemple, dans le cas de l’événement WebPartAdded , un développeur de pages peut ajouter un attribut à l’élément OnWebPartAdded<asp:webpartmanager> dans le balisage d’une page web, puis affecter un nom de méthode personnalisé à l’attribut pour fournir une gestion personnalisée de l’événement. L’attribut correspond à la OnWebPartAdded méthode, et ce modèle de base de gestion des événements fonctionne pour la plupart des événements WebPart et leurs méthodes associées.

En outre, le WebPartManager contrôle a des méthodes spécifiques à la tâche de gestion WebPart des contrôles (et des contrôles serveur ou utilisateur utilisés comme WebPart contrôles). Ces méthodes incluent AddWebPart, AuthorizeWebPart, CloseWebPart, CopyWebPart, CreateWebPartDisconnectWebPartDeleteWebPart, , BeginWebPartEditing, , EndWebPartEditing, , ExportWebPart, GetGenericWebPart, , ImportWebPart, IsAuthorizedet .MoveWebPart

Un autre ensemble de méthodes est spécialisé pour les connexions. Cela inclut des méthodes telles que ActivateConnections, BeginWebPartConnecting, CanConnectWebParts, CreateAvailableTransformersConnectWebParts, DisconnectWebPart, DisconnectWebParts, , EndWebPartConnecting, , GetConsumerConnectionPointset GetProviderConnectionPoints.

Enfin, certaines WebPartManager méthodes se concentrent sur la fonctionnalité de personnalisation. Il s’agit notamment de CreatePersonalization, LoadControlState, SaveCustomPersonalizationState, SetPersonalizationDirty, IPersonalizable.Load, IPersonalizable.Save et SaveControlState.

Pour plus d’informations sur les autres WebPartManager méthodes accessibles via la Internals propriété, consultez la documentation relative à la WebPartManagerInternals classe .

Notes pour les héritiers

Le WebPartManager contrôle est conçu pour être étendu. Étant donné qu’il est essentiel pour les applications WebPart, lorsque vous souhaitez étendre un type ou un contrôle spécifique dans le jeu de contrôles WebPart, dans de nombreux cas, vous devez également étendre la WebPartManager classe, car il est probable qu’une propriété ou une méthode soit nécessaire pour que votre type personnalisé fonctionne dans le contexte d’une application WebPart. La documentation de référence sur les composants WebPart (voir System.Web.UI.WebControls.WebParts), quand vous expliquez comment étendre un type de composants WebPart, mentionne fréquemment ce qui doit être fait pour étendre la WebPartManager classe ou montre comment l’étendre dans un exemple de code.

Constructeurs

Champs

Propriétés

Méthodes

Événements

Implémentations d’interfaces explicites

Méthodes d’extension

S’applique à

Voir aussi

• WebPartManagerInternals
• contrôles de composants WebPart ASP.NET