CatalogPartCollection Classe

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.

Contient une collection de contrôles CatalogPart utilisés pour fournir des catalogues de contrôles serveur web que les utilisateurs finaux peuvent ajouter à une page web. Cette classe ne peut pas être héritée.

public ref class CatalogPartCollection sealed : System::Collections::ReadOnlyCollectionBase

public sealed class CatalogPartCollection : System.Collections.ReadOnlyCollectionBase

type CatalogPartCollection = class
    inherit ReadOnlyCollectionBase

Public NotInheritable Class CatalogPartCollection
Inherits ReadOnlyCollectionBase

Héritage: Object

ReadOnlyCollectionBase
CatalogPartCollection

Exemples

L’exemple de code suivant illustre plusieurs utilisations de la CatalogPartCollection classe . Cet exemple de code comporte quatre parties :

Contrôle utilisateur qui vous permet de modifier les modes d’affichage sur une page de composants WebPart.
Classe pour un contrôle personnalisé WebPart nommé TextDisplayWebPart, qui est référencée dans la page Web et contenue dans l’un CatalogPart des contrôles.
Page Web qui fait référence au TextDisplayWebPart contrôle, contient un CatalogZone contrôle avec deux des CatalogPart contrôles du jeu de contrôles WebPart déclarés dans la zone, et contient du code piloté par les événements pour créer et manipuler un CatalogPartCollection objet.
Explication du fonctionnement de l’exemple de code lorsque vous le chargez dans un navigateur.

La première partie de l’exemple de code est le contrôle utilisateur. Le code source du contrôle utilisateur provient d’une autre rubrique. Pour que cet exemple de code fonctionne, vous devez obtenir le fichier .ascx pour le contrôle utilisateur à partir de la rubrique Procédure pas à pas : modification des modes d’affichage sur une page de composants WebPart , et placer le fichier dans le même dossier que la page .aspx dans cet exemple de code.

La deuxième partie de l’exemple de code est le TextDisplayWebPart 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. Pour obtenir une procédure pas à pas qui illustre les deux méthodes de compilation, consultez Procédure pas à pas : développement et utilisation d’un contrôle serveur Web personnalisé. Notez que le contrôle a une propriété nommée ContentText; cette propriété contient la valeur que l’utilisateur entre dans la zone de texte.

using System;
using System.Collections;
using System.ComponentModel;
using System.Drawing;
using System.Security.Permissions;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;

namespace Samples.AspNet.CS.Controls
{
  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public class TextDisplayWebPart : WebPart
  {
    private String _contentText = null;
    TextBox input;
    Label DisplayContent;
    Literal lineBreak;

    [Personalizable(), WebBrowsable]
    public String ContentText
    {
      get { return _contentText; }
      set { _contentText = value; }
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();
      DisplayContent = new Label();
      DisplayContent.BackColor = Color.LightBlue;
      DisplayContent.Text = this.ContentText;
      this.Controls.Add(DisplayContent);

      lineBreak = new Literal();
      lineBreak.Text = @"<br />";
      Controls.Add(lineBreak);

      input = new TextBox();
      this.Controls.Add(input);
      Button update = new Button();
      update.Text = "Set Label Content";
      update.Click += new EventHandler(this.submit_Click);
      this.Controls.Add(update);
    }

    private void submit_Click(object sender, EventArgs e)
    {
      // Update the label string.
      if (!string.IsNullOrEmpty(input.Text))
      {
        _contentText = input.Text + @"<br />";
        input.Text = String.Empty;
        DisplayContent.Text = this.ContentText;
      }
    }
  }
}

Imports System.Collections
Imports System.ComponentModel
Imports System.Drawing
Imports System.Security.Permissions
Imports System.Web
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 Class TextDisplayWebPart
    Inherits WebPart
    Private _contentText As String = Nothing
    Private _fontStyle As String = Nothing
    Private input As TextBox
    Private DisplayContent As Label
    Private lineBreak As Literal

    <Personalizable(), WebBrowsable()> _
    Public Property ContentText() As String
      Get
        Return _contentText
      End Get
      Set(ByVal value As String)
        _contentText = value
      End Set
    End Property

    Protected Overrides Sub CreateChildControls()
      Controls.Clear()
      DisplayContent = New Label()
      DisplayContent.BackColor = Color.LightBlue
      DisplayContent.Text = Me.ContentText
      Me.Controls.Add(DisplayContent)

      lineBreak = New Literal()
      lineBreak.Text = "<br />"
      Controls.Add(lineBreak)

      input = New TextBox()
      Me.Controls.Add(input)
      Dim update As New Button()
      update.Text = "Set Label Content"
      AddHandler update.Click, AddressOf Me.submit_Click
      Me.Controls.Add(update)

    End Sub

    Private Sub submit_Click(ByVal sender As Object, _
                             ByVal e As EventArgs)
      ' Update the label string.
      If input.Text <> String.Empty Then
        _contentText = input.Text + "<br />"
        input.Text = String.Empty
        DisplayContent.Text = Me.ContentText
      End If

    End Sub

  End Class

End Namespace

La troisième partie de l’exemple de code est la page Web. Notez que l’élément <asp:catalogzone> de la page contient des déclarations pour deux CatalogPart contrôles. Ces contrôles font partie d’un objet personnalisé CatalogPartCollection créé lorsque la méthode s’exécute Button1_Click . Le PageCatalogPart contrôle contient des contrôles serveur Web qui ont été précédemment fermés par un utilisateur au moment de l’exécution. Les contrôles du PageCatalogPart contrôle peuvent être ajoutés à une page. Le DeclarativeCatalogPart contrôle contient une déclaration du contrôle personnalisé TextDisplayWebPart . Lorsque la page est en mode catalogue, un utilisateur peut ajouter le TextDisplayWebPart contrôle à la page afin qu’il puisse être utilisé en mode de navigation normal.

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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
  // <snippet2>
  protected void Button1_Click(object sender, EventArgs e)
  {
    ArrayList list = new ArrayList(2);
    list.Add(PageCatalogPart1);
    list.Add(DeclarativeCatalogPart1);
    // Pass an ICollection object to the constructor.
    CatalogPartCollection myParts = new CatalogPartCollection(list);
    foreach (CatalogPart catalog in myParts)
    {
      catalog.Description = "My " + catalog.DisplayTitle;
    }

    // Use the IndexOf property to locate a CatalogPart control.
    int PageCatalogPartIndex = myParts.IndexOf(PageCatalogPart1);
    myParts[PageCatalogPartIndex].ChromeType = PartChromeType.TitleOnly;

    // Use the Contains method to see if a CatalogPart control exists.
    if (myParts.Contains(PageCatalogPart1))
    {
      WebPart closedWebPart = null;
      WebPartDescriptionCollection descriptions = PageCatalogPart1.GetAvailableWebPartDescriptions();
      if (descriptions.Count > 0)
      {
        closedWebPart = PageCatalogPart1.GetWebPart(descriptions[0]);
        closedWebPart.AllowClose = false;
      }
    }
    
    // Use indexers to display the details of the CatalogPart controls.
    Label1.Text = String.Empty;
    Label1.Text =
      "<h3>PageCatalogPart Details</h3>" +
      "ID: " + myParts[0].ID + "<br />" +
      "Count: " + myParts[0].GetAvailableWebPartDescriptions().Count;
    Label1.Text += 
      "<h3>DeclarativeCatalogPart Details</h3>" +
      "ID: " + myParts["DeclarativeCatalogPart1"].ID + "<br />" +
      "Count: " + myParts["DeclarativeCatalogPart1"].GetAvailableWebPartDescriptions().Count;
  }
  // </snippet2>
</script> 
 
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>PageCatalogPart Details</title>
</head>
<body>
  <form id="form1" runat="server">
    <asp:WebPartManager ID="WebPartManager1" runat="server" />
    <uc1:DisplayModeMenuCS ID="DisplayModeMenu1" runat="server" />
    <asp:WebPartZone ID="WebPartZone1" runat="server">
      <ZoneTemplate>
        <asp:BulletedList 
          ID="BulletedList1" 
          Runat="server"
          DisplayMode="HyperLink" 
          Title="Favorite Links" >
          <asp:ListItem Value="http://msdn.microsoft.com">
            MSDN
          </asp:ListItem>
          <asp:ListItem Value="http://www.asp.net">
            ASP.NET
          </asp:ListItem>
          <asp:ListItem Value="http://www.msn.com">
            MSN
          </asp:ListItem>
        </asp:BulletedList>
      </ZoneTemplate>
    </asp:WebPartZone>
    <asp:CatalogZone ID="CatalogZone1" runat="server">
      <ZoneTemplate>
        <asp:DeclarativeCatalogPart ID="DeclarativeCatalogPart1" runat="server">
          <WebPartsTemplate>
            <aspSample:TextDisplayWebPart runat="server" 
              id="TextDisplayWebPart1"
              Title="Text Display WebPart" />
          </WebPartsTemplate>
        </asp:DeclarativeCatalogPart>
        <asp:PageCatalogPart ID="PageCatalogPart1" runat="server" />  
      </ZoneTemplate>
    </asp:CatalogZone>
    <hr />
    <asp:Button ID="Button1" 
      runat="server" 
      Text="Display CatalogPart Properties" 
      OnClick="Button1_Click"/>
    <br />
    <asp:Label ID="Label1" runat="server" Text="" /> 
  </form>
</body>
</html>

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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
' <snippet2>
Protected Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs) 
    Dim list As New ArrayList(2)
    list.Add(PageCatalogPart1)
    list.Add(DeclarativeCatalogPart1)
    ' Pass an ICollection object to the constructor.
    Dim myParts As New CatalogPartCollection(list)
    Dim catalog As CatalogPart
    For Each catalog In  myParts
        catalog.Description = "My " + catalog.DisplayTitle
    Next catalog
    
    ' Use the IndexOf property to locate a CatalogPart control.
    Dim PageCatalogPartIndex As Integer = _
      myParts.IndexOf(PageCatalogPart1)
    myParts(PageCatalogPartIndex).ChromeType = PartChromeType.TitleOnly
    
    ' Use the Contains method to see if a CatalogPart control exists.
    If myParts.Contains(PageCatalogPart1) Then
        Dim closedWebPart As WebPart = Nothing
        Dim descriptions As WebPartDescriptionCollection = _
          PageCatalogPart1.GetAvailableWebPartDescriptions()
        If descriptions.Count > 0 Then
            closedWebPart = PageCatalogPart1.GetWebPart(descriptions(0))
            closedWebPart.AllowClose = False
        End If
    End If
    
    ' Use indexers to display the details of the CatalogPart controls.
    Label1.Text = String.Empty
    Label1.Text = _
      "<h3>PageCatalogPart Details</h3>" & _
      "ID: " & myParts(0).ID + "<br />" & _
      "Count: " & myParts(0).GetAvailableWebPartDescriptions().Count
    Label1.Text += _
      "<h3>DeclarativeCatalogPart Details</h3>" & _
      "ID: " & myParts("DeclarativeCatalogPart1").ID & "<br />" & _
      "Count: " & myParts("DeclarativeCatalogPart1") _
        .GetAvailableWebPartDescriptions().Count

End Sub 
' </snippet2>
</script>  
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>PageCatalogPart Details</title>
</head>
<body>
  <form id="form1" runat="server">
    <asp:WebPartManager ID="WebPartManager1" runat="server" />
    <uc1:DisplayModeMenuVB ID="DisplayModeMenu1" runat="server" />
    <asp:WebPartZone ID="WebPartZone1" runat="server">
      <ZoneTemplate>
        <asp:BulletedList 
          ID="BulletedList1" 
          Runat="server"
          DisplayMode="HyperLink" 
          Title="Favorite Links" >
          <asp:ListItem Value="http://msdn.microsoft.com">
            MSDN
          </asp:ListItem>
          <asp:ListItem Value="http://www.asp.net">
            ASP.NET
          </asp:ListItem>
          <asp:ListItem Value="http://www.msn.com">
            MSN
          </asp:ListItem>
        </asp:BulletedList>
      </ZoneTemplate>
    </asp:WebPartZone>
    <asp:CatalogZone ID="CatalogZone1" runat="server">
      <ZoneTemplate>
        <asp:DeclarativeCatalogPart ID="DeclarativeCatalogPart1" runat="server">
          <WebPartsTemplate>
            <aspSample:TextDisplayWebPart runat="server" 
              id="TextDisplayWebPart1"
              Title="Text Display WebPart" />
          </WebPartsTemplate>
        </asp:DeclarativeCatalogPart>
        <asp:PageCatalogPart ID="PageCatalogPart1" runat="server" />  
      </ZoneTemplate>
    </asp:CatalogZone>
    <hr />
    <asp:Button ID="Button1" 
      runat="server" 
      Text="Display CatalogPart Properties" 
      OnClick="Button1_Click"/>
    <br />
    <asp:Label ID="Label1" runat="server" Text="" /> 
  </form>
</body>
</html>

Lorsque vous chargez la page dans un navigateur, vous pouvez basculer la page en mode catalogue en sélectionnant Catalogue dans le contrôle de liste déroulante Mode d’affichage . Vous pouvez ajouter le contrôle personnalisé WebPart à la page en cochée la case en regard de celle-ci et en cliquant sur Ajouter. Cliquez sur Fermer pour renvoyer la page en mode de navigation. Dans le contrôle que vous venez d’ajouter, si vous cliquez sur le menu verbes (la flèche vers le bas qui apparaît dans la barre de titre), puis cliquez sur Fermer, le contrôle est supprimé de la page et ajouté au PageCatalogPart contrôle. Retournez la page en mode catalogue, puis cliquez sur le lien Catalogue de pages pour afficher le contenu du PageCatalogPart contrôle. Notez que le contrôle que vous avez fermé s’affiche à présent. Cliquez sur le bouton Afficher les propriétés du cataloguePart pour accéder à l’objet CatalogPartCollection et affiche certaines propriétés des contrôles contenus CatalogPart .

Remarques

La CatalogPartCollection classe est une collection de contrôles en CatalogPart lecture seule, généralement utilisée par une CatalogZoneBase zone pour suivre l’ensemble de CatalogPart contrôles contenus dans la zone.

Lorsqu’une page de composants WebPart passe en mode catalogue, la zone crée un CatalogPartCollection objet constitué des CatalogPart contrôles. Chaque CatalogPart contrôle de la collection peut contenir des références à zéro ou plusieurs contrôles serveur Web, qui sont affichés sous la forme d’un catalogue de contrôles serveur disponibles.

Vous pouvez créer une CatalogPartCollection collection de contrôles pour votre propre utilisation programmatique si, par exemple, vous devez effectuer une opération de masse sur un ensemble de CatalogPart contrôles. Même si l’objet CatalogPartCollection est en lecture seule, vous pouvez apporter des modifications programmatiques aux contrôles sous-jacents référencés dans la collection.

Constructeurs

CatalogPartCollection()	Initialise une nouvelle instance vide de la classe CatalogPartCollection.
CatalogPartCollection(CatalogPartCollection, ICollection)	Initialise une nouvelle instance de la classe CatalogPartCollection en passant dans une collection ICollection des contrôles CatalogPart existants dans une zone, et dans une collection supplémentaire de contrôles.
CatalogPartCollection(ICollection)	Initialise une nouvelle instance d'une classe CatalogPartCollection en passant dans une collection ICollection de contrôles CatalogPart.

Champs

Empty

Référence une instance vide, statique et en lecture seule de la collection.

Propriétés

Count	Obtient le nombre d'éléments contenus dans l'instance ReadOnlyCollectionBase. (Hérité de ReadOnlyCollectionBase)
InnerList	Obtient la liste des éléments contenus dans l’instance de ReadOnlyCollectionBase. (Hérité de ReadOnlyCollectionBase)
Item[Int32]	Obtient ou définit un membre de la collection d'après sa position dans la collection.
Item[String]	Retourne un membre de la collection d'après son identificateur de chaîne unique.

Méthodes

Contains(CatalogPart)	Retourne une valeur indiquant si un contrôle particulier existe dans la collection.
CopyTo(CatalogPart[], Int32)	Copie la collection dans un tableau d'objets CatalogPart.
Equals(Object)	Détermine si l'objet spécifié est égal à l'objet actuel. (Hérité de Object)
GetEnumerator()	Retourne un énumérateur qui itère au sein de l'instance ReadOnlyCollectionBase. (Hérité de ReadOnlyCollectionBase)
GetHashCode()	Fait office de fonction de hachage par défaut. (Hérité de Object)
GetType()	Obtient le Type de l'instance actuelle. (Hérité de Object)
IndexOf(CatalogPart)	Retourne la position d'un membre particulier de la collection.
MemberwiseClone()	Crée une copie superficielle du Object actuel. (Hérité de Object)
ToString()	Retourne une chaîne qui représente l'objet actuel. (Hérité de Object)

Implémentations d’interfaces explicites

ICollection.CopyTo(Array, Int32)	Copie l'ensemble de l'objet ReadOnlyCollectionBase vers un objet Array unidimensionnel compatible, en commençant à l'index spécifié du tableau cible. (Hérité de ReadOnlyCollectionBase)
ICollection.IsSynchronized	Obtient une valeur indiquant si l'accès à un objet ReadOnlyCollectionBase est synchronisé (thread-safe). (Hérité de ReadOnlyCollectionBase)
ICollection.SyncRoot	Obtient un objet qui peut être utilisé pour synchroniser l'accès à un objet ReadOnlyCollectionBase. (Hérité de ReadOnlyCollectionBase)

Méthodes d’extension

Cast<TResult>(IEnumerable)	Effectue un cast des éléments d'un IEnumerable vers le type spécifié.
OfType<TResult>(IEnumerable)	Filtre les éléments d'un IEnumerable en fonction du type spécifié.
AsParallel(IEnumerable)	Active la parallélisation d'une requête.
AsQueryable(IEnumerable)	Convertit un IEnumerable en IQueryable.

S’applique à

Partager via