CatalogPart Classe

Définition

public ref class CatalogPart abstract : System::Web::UI::WebControls::WebParts::Part

[System.ComponentModel.Bindable(false)]
public abstract class CatalogPart : System.Web.UI.WebControls.WebParts.Part

[<System.ComponentModel.Bindable(false)>]
type CatalogPart = class
    inherit Part

Public MustInherit Class CatalogPart
Inherits Part

Héritage

Object

Control

WebControl

Panel

Part

CatalogPart

Dérivé

System.Web.UI.WebControls.WebParts.DeclarativeCatalogPart

System.Web.UI.WebControls.WebParts.ImportCatalogPart

System.Web.UI.WebControls.WebParts.PageCatalogPart

Attributs

BindableAttribute

Exemples

L’exemple de code suivant illustre l’utilisation de la CatalogPart classe . Étant donné que la classe est abstraite, elle n’est pas utilisée directement dans le code. Toutefois, l’exemple montre comment utiliser les trois contrôles dérivés CatalogPart fournis avec l’ensemble de contrôles WebPart pour illustrer les scénarios d’utilisation courants.

L’exemple de code comporte quatre parties :

• Contrôle utilisateur qui vous permet de modifier les modes d’affichage sur la page Web.

• Une page Web, qui contient les trois CatalogPart contrôles fournis avec l’ensemble de contrôles WebPart, tous déclarés dans un CatalogZone sur une page Web. La page contient également un WebPartZone contrôle, avec un AdRotator contrôle déclaré dans la zone.

• Fichier XML qui contient des citations affichées dans le AdRotator contrôle de la page Web.

• Explication de l’exécution de l’exemple.

La première partie de cet exemple de code est le contrôle utilisateur qui permet aux utilisateurs de modifier les modes d’affichage sur une page Web. Vous devez enregistrer ce code dans un fichier nommé DisplayModeMenuCS.ascx ou DisplayModeMenuVB.ascx (selon la langue que vous utilisez). 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>

La deuxième partie de l’exemple de code est la page Web. La page contient un CatalogZone contrôle et, dans l’élément enfant <zonetemplate> , chacun des trois CatalogPart contrôles fournis avec le jeu de contrôles WebPart est déclaré. Certains attributs sont définis sur le DeclarativeCatalogPart contrôle, et également dans la <section script> de la page, les attributs de ce contrôle sont accessibles par programmation. Le contrôle contient un contrôle enfant qu’un utilisateur peut ajouter à la page : un contrôle standard Calendar . Le CatalogZone contrôle et CatalogPart ne sera visible que lorsque l’utilisateur bascule la page en mode d’affichage catalogue.

La page contient également un WebPartZone contrôle et, dans son élément enfant <zonetemplate> , se trouve un AdRotator contrôle qui affiche des messages en alternance à partir d’un fichier XML. Si un utilisateur ferme le contrôle en cliquant sur son verbe de fermeture lorsque la page est affichée, le contrôle est ajouté au catalogue de pages et l’utilisateur peut rouvrir le contrôle en basculant la page en mode d’affichage du catalogue, en accédant au PageCatalogPart contrôle et en ajoutant à nouveau le contrôle fermé.

<%@ Page Language="C#" %>
<%@ register TagPrefix="uc1" 
  TagName="DisplayModeMenuCS" 
  Src="DisplayModeMenuCS.ascx" %>
  
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
  
  // <snippet3>
  protected void Button1_Click(object sender, EventArgs e)
  {
    
    Label1.Text = "<h3>DeclarativeCatalogPart Property Values</h3>" +
      "Display Title: " + DeclarativeCatalogPart1.DisplayTitle + 
      "<br />" + 
      "Description: " + DeclarativeCatalogPart1.Description + 
      "<br />" + 
      "Chrome type: " + DeclarativeCatalogPart1.ChromeType.ToString();
  }

  protected void WebPartManager1_DisplayModeChanged(object sender, 
    WebPartDisplayModeEventArgs e)
  {
    Label1.Text = String.Empty;
    if (WebPartManager1.DisplayMode == WebPartManager.CatalogDisplayMode)
      Button1.Visible = true;
    else
      Button1.Visible = false;
  }
  // </snippet3>
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>CatalogPart Samples</title>
</head>
<body>
  <form id="form1" runat="server">
    <asp:WebPartManager ID="WebPartManager1" runat="server" 
      OnDisplayModeChanged="WebPartManager1_DisplayModeChanged" />
    <uc1:DisplayModeMenuCS ID="DisplayModeMenu1" runat="server" />
    <asp:WebPartZone ID="WebPartZone1" runat="server">
      <ZoneTemplate>
        <asp:AdRotator ID="AdRotator1" runat="server" 
          AdvertisementFile="~/quotes.xml" 
          Title="Favorite Quotes"  />         
      </ZoneTemplate>
    </asp:WebPartZone>
    <asp:CatalogZone ID="CatalogZone1" runat="server">
      <ZoneTemplate>
        <asp:DeclarativeCatalogPart 
          ID="DeclarativeCatalogPart1" 
          runat="server"
          Title="Controls to Add"
          ChromeType="TitleOnly"
          Description="Provides a list of controls that users can
            add to the page.">
          <WebPartsTemplate>
            <asp:Calendar ID="Calendar1" runat="server" 
              Title="My Calendar" />         
          </WebPartsTemplate>
        </asp:DeclarativeCatalogPart>
        <asp:PageCatalogPart ID="PageCatalogPart1" runat="server" />
        <asp:importcatalogpart id="ImportCatalogPart1" runat="server" />
      </ZoneTemplate>
    </asp:CatalogZone>
    <hr />
    <asp:Button ID="Button1" runat="server" 
      Text="Display DeclarativeCatalogPart Properties" 
      OnClick="Button1_Click" 
      Visible="false"/>
    <br />
    <asp:Label ID="Label1" runat="server" Text="" />
  </form>
</body>
</html>

<%@ Page Language="vb" %>
<%@ register TagPrefix="uc1" 
  TagName="DisplayModeMenuVB" 
  Src="DisplayModeMenuVB.ascx" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">
  ' <snippet3>
  Protected Sub Button1_Click(ByVal sender As Object, _
    ByVal e As EventArgs)
    
    Label1.Text = "<h3>DeclarativeCatalogPart Property Values</h3>" & _
      "Display Title: " & DeclarativeCatalogPart1.DisplayTitle & _
      "<br />" & _
      "Description: " & DeclarativeCatalogPart1.Description & _
      "<br />" & _
      "Chrome type: " & DeclarativeCatalogPart1.ChromeType.ToString()
    
  End Sub

  Protected Sub WebPartManager1_DisplayModeChanged(ByVal sender _
    As Object, ByVal e As WebPartDisplayModeEventArgs)
    Label1.Text = String.Empty
    If WebPartManager1.DisplayMode _
      Is WebPartManager.CatalogDisplayMode Then
      Button1.Visible = True
    Else
      Button1.Visible = False
    End If
  End Sub
  ' </snippet3>
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>CatalogPart Samples</title>
</head>
<body>
  <form id="form1" runat="server">
    <asp:WebPartManager ID="WebPartManager1" runat="server" 
      OnDisplayModeChanged="WebPartManager1_DisplayModeChanged" />
    <uc1:DisplayModeMenuVB ID="DisplayModeMenu1" runat="server" />
    <asp:WebPartZone ID="WebPartZone1" runat="server">
      <ZoneTemplate>
        <asp:AdRotator ID="AdRotator1" runat="server" 
          AdvertisementFile="~/quotes.xml" 
          Title="Favorite Quotes"  />         
      </ZoneTemplate>
    </asp:WebPartZone>
    <asp:CatalogZone ID="CatalogZone1" runat="server">
      <ZoneTemplate>
        <asp:DeclarativeCatalogPart 
          ID="DeclarativeCatalogPart1" 
          runat="server"
          Title="Controls to Add"
          ChromeType="TitleOnly"
          Description="Provides a list of controls that users can
            add to the page.">
          <WebPartsTemplate>
            <asp:Calendar ID="Calendar1" runat="server" 
              Title="My Calendar" />         
          </WebPartsTemplate>
        </asp:DeclarativeCatalogPart>
        <asp:PageCatalogPart ID="PageCatalogPart1" runat="server" />
        <asp:importcatalogpart id="ImportCatalogPart1" runat="server" />
      </ZoneTemplate>
    </asp:CatalogZone>
    <hr />
    <asp:Button ID="Button1" runat="server" 
      Text="Display DeclarativeCatalogPart Properties" 
      OnClick="Button1_Click" 
      Visible="false"/>
    <br />
    <asp:Label ID="Label1" runat="server" Text="" />
  </form>
</body>
</html>

La troisième partie de l’exemple de code est le fichier XML. Ce fichier est un fichier source pour le AdRotator contrôle qui est déclaré sur la page. Le fichier contient des guillemets favoris, que le contrôle pivote et affiche régulièrement. Copiez le contenu suivant dans un éditeur de texte et enregistrez le fichier en tant que Quotes.xml.

<?xml version="1.0" encoding="utf-8" ?>  
<Advertisements>  
  <Ad>  
    <AlternateText>  
      A stitch in time saves nine.  
    </AlternateText>      
  </Ad>  
  <Ad>  
    <AlternateText>  
      A penny saved is a penny earned.  
    </AlternateText>      
  </Ad>  
</Advertisements>  

Pour exécuter l’exemple de code, chargez la page Web dans un navigateur. Utilisez le contrôle déroulant Modes d’affichage pour sélectionner Catalogue et basculer la page en mode d’affichage catalogue. Notez les effets des différentes valeurs de propriété qui ont été définies sur le DeclarativeCatalogPart contrôle qui contient le Calendar contrôle. Vous pouvez sélectionner la zone case activée en regard du Calendar contrôle, puis cliquer sur Ajouter pour l’ajouter à la page. Si vous cliquez sur le bouton Afficher les propriétés déclarativesCatalogPart , les valeurs des propriétés de ce contrôle s’affichent. Vous pouvez cliquer sur Fermer pour retourner la page en mode de navigation normal et voir le contrôle ajouté sur la page. Accédez maintenant au menu verbes du AdRotator contrôle (représenté par la flèche vers le bas dans la barre de titre), puis cliquez sur Fermer. Le contrôle est fermé et ajouté au catalogue de pages. Basculez à nouveau la page en mode d’affichage catalogue, puis cliquez sur le lien hypertexte Catalogue de pages pour afficher le PageCatalogPart contrôle. Notez que le AdRotator contrôle y est référencé par son titre, Guillemets favoris. Sélectionnez le contrôle Guillemets favoris , puis cliquez sur le bouton Ajouter pour rajouter le contrôle à la page. Cliquez sur le bouton Fermer pour retourner la page en mode de navigation.

Remarques

La CatalogPart classe est une classe de base pour les contrôles spéciaux qui résident dans des CatalogZoneBase zones. Ces contrôles dérivés CatalogPart fournissent des catalogues de contrôles de serveur Web que les utilisateurs finaux peuvent ajouter à une page Web. Utilisez CatalogPart des contrôles dans une application web lorsque vous souhaitez offrir aux utilisateurs finaux la flexibilité nécessaire pour modifier les fonctionnalités d’une page Web en ajoutant ou en supprimant des contrôles serveur.

Un catalogue est simplement une liste d’un ou plusieurs contrôles serveur Web disponibles (y compris WebPart les contrôles, les contrôles ASP.NET serveur et les contrôles personnalisés ou utilisateur) que les utilisateurs peuvent ajouter à une page Web. Un catalogue présente un certain nombre de caractéristiques communes, notamment le texte d’instructions pour les utilisateurs finaux ; texte pour décrire chaque contrôle serveur ; contrôles d’assistance pour sélectionner les contrôles serveur et les ajouter à la page ; un en-tête, un pied de page et une bordure communs ; et un certain nombre d’attributs de style.

Il existe trois types de CatalogPart contrôles fournis avec l’ensemble de contrôles WebPart, comme décrit dans le tableau suivant. Chaque type de contrôle contient des CatalogPart contrôles serveur qui sont ajoutés à une page à partir d’une source différente.

La CatalogPart classe hérite de la classe de base Part , de sorte qu’elle a le comportement commun d’autres contrôles de composant dans le jeu de contrôles WebPart. En outre, il ajoute des membres qui sont utiles pour les fonctionnalités du catalogue. La DisplayTitle propriété obtient la chaîne réelle qui est actuellement affichée en tant que titre du contrôle. La valeur de cette propriété peut être identique à la valeur de la Title propriété ou, si aucune valeur n’a été affectée à cette propriété, valeur par défaut fournie par .NET Framework. Les WebPartManager propriétés et Zone fournissent un accès pratique aux deux objets essentiels qui contrôlent le cycle de vie d’un CatalogPart contrôle : le WebPartManager contrôle et la CatalogZoneBase zone qui contient le CatalogPart contrôle, respectivement.

La CatalogPart classe contient également plusieurs méthodes. La GetAvailableWebPartDescriptions méthode est déclarée en tant que méthode abstraite qui doit être implémentée par les héritiers. Son objectif est de retourner une collection de descriptions des contrôles dans le catalogue. Une méthode associée, GetWebPart, est également déclarée comme abstraite et doit être implémentée par les héritiers. Cette méthode est destinée à retourner un instance d’un WebPart contrôle basé sur une description qui est passée à la méthode en tant que paramètre.

Notes pour les responsables de l’implémentation

Étant donné que la CatalogPart classe est abstraite, vous ne pouvez pas l’utiliser directement sur une page Web. Le jeu de contrôles WebPart fournit trois CatalogPart contrôles (répertoriés dans le tableau de la section Remarques de cette rubrique) qui dérivent de la classe de base et qui peuvent être utilisés sur les pages de composants WebPart. Ces contrôles doivent fournir la plupart des fonctionnalités nécessaires pour créer des catalogues de contrôles serveur web. Toutefois, vous pouvez avoir des besoins spécialisés qui nécessiteraient le développement d’un contrôle personnalisé CatalogPart . Par exemple, vous pouvez créer un type spécial de CatalogPart contrôle qui rend les contrôles serveur disponibles via un service Web ou directement à partir d’une base de données. Pour ce faire, vous devez hériter de la CatalogPart classe . Vous devez également remplacer les méthodes abstraites GetAvailableWebPartDescriptions() et pour GetWebPart(WebPartDescription) fournir une implémentation qui retourne ou WebPart d’autres contrôles serveur, ainsi que leurs descriptions. Vous aurez également besoin de méthodes pour charger les différents contrôles serveur à partir de votre base de données ou de votre service Web.

Constructeurs

Propriétés

Méthodes

Événements

Implémentations d’interfaces explicites

Méthodes d’extension

S’applique à

Voir aussi

• CatalogZoneBase
• Procédure pas à pas : développement et utilisation d’un contrôle serveur personnalisé
• Procédure pas à pas : modification des modes d’affichage sur une page de composants WebPart
• contrôles webPart ASP.NET