CatalogPart Classe

Definição

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

Herança

Object

Control

WebControl

Panel

Part

CatalogPart

Derivado

System.Web.UI.WebControls.WebParts.DeclarativeCatalogPart

System.Web.UI.WebControls.WebParts.ImportCatalogPart

System.Web.UI.WebControls.WebParts.PageCatalogPart

Atributos

BindableAttribute

Exemplos

O seguinte exemplo de código demonstra a utilização da CatalogPart classe. Como a classe é abstrata, não é usada diretamente em código. No entanto, o exemplo mostra como trabalhar com os três controlos derivados CatalogPart fornecidos pelo conjunto de controlos Web Parts para demonstrar cenários de uso comum.

Existem quatro partes no exemplo de código:

• Um controlo do utilizador que permite alterar os modos de visualização na página Web.

• Uma página Web, que contém os três CatalogPart controlos fornecidos pelo conjunto de controlos Web Parts, todos declarados dentro de uma CatalogZone página Web. A página contém também um WebPartZone controlo, com um AdRotator controlo declarado na zona.

• Um ficheiro XML que contém aspas exibidas AdRotator no controlo na página Web.

• Uma explicação de como executar o exemplo.

A primeira parte deste exemplo de código é o controlo do utilizador que permite aos utilizadores alterar modos de visualização numa página Web. Deves guardar este código num ficheiro chamado DisplayModeMenuCS.ascx ou DisplayModeMenuVB.ascx (dependendo da língua que estás a usar). Para detalhes sobre modos de visualização e uma descrição do código-fonte neste controlo, consulte Walkthrough: Changing Display Modes on a Web Parts Page.

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

A segunda parte do exemplo do código é a página Web. A página contém um CatalogZone controlo e, dentro do elemento filho <zonetemplate> , cada um dos três CatalogPart controlos fornecidos pelo conjunto de controlos Web Parts é declarado. Alguns atributos são definidos no DeclarativeCatalogPart controlo e, também na <secção de script> da página, os atributos desse controlo são acedidos programaticamente. O controlo contém um controlo filho que o utilizador pode adicionar à página: um controlo padrão Calendar . O CatalogZone controlo and CatalogPart só será visível quando o utilizador mudar a página para o modo de visualização de catálogo.

A página também contém um WebPartZone controlo, e dentro do seu elemento filho <zonetemplate> há um AdRotator controlo que exibe mensagens alternadas de um ficheiro XML. Se um utilizador fechar o controlo clicando no seu verbo fechar quando a página é exibida, o controlo é adicionado ao catálogo de páginas, e o utilizador pode reabrir o controlo mudando a página para o modo de visualização do catálogo, acedendo ao PageCatalogPart controlo e adicionando novamente o controlo fechado.

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

A terceira parte do exemplo de código é o ficheiro XML. Este ficheiro é um ficheiro-fonte para o AdRotator controlo que é declarado na página. O ficheiro contém citações favoritas, que o controlo roda e exibe periodicamente. Copie o conteúdo seguinte para um editor de texto e guarde o ficheiro como 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>

Para executar o exemplo de código, carregue a página Web num navegador. Use o menu suspenso de Modos de Visualização para selecionar Catálogo e mudar a página para o modo de visualização de catálogo. Note os efeitos dos vários valores de propriedade que foram definidos no DeclarativeCatalogPart controlo que contém o Calendar controlo. Pode selecionar a caixa ao lado do Calendar controlo e clicar em Adicionar para adicionar à página. Se clicar no botão Exibir Propriedades do CatalogCatalogPart Declarativo, os valores das propriedades desse controlo são exibidos. Pode clicar em Fechar para voltar a página ao modo normal de navegação e ver o controlo adicional na página. Agora vai ao menu de verbos no AdRotator controlo (representado pela seta para baixo na barra de título) e clica em Fechar. O controlo é fechado e adicionado ao catálogo de páginas. Mude novamente a página para o modo de exibição de catálogo e clique no hiperlink Catálogo de Páginas para mostrar o PageCatalogPart controlo. Note que o AdRotator controlo é referido ali pelo seu título, Citações Favoritas. Selecione o controlo Citações Favoritas e clique no botão Adicionar para adicionar o controlo de volta à página. Clique no botão Fechar para voltar a página ao modo de navegação.

Observações

A CatalogPart classe é uma base para controlos especiais que residem em CatalogZoneBase zonas. Estes controlos derivados CatalogPart fornecem catálogos de controlos de servidores Web que os utilizadores finais podem adicionar a uma página Web. Use CatalogPart controlos numa aplicação Web quando quiser proporcionar aos utilizadores finais a flexibilidade de alterar a funcionalidade de uma página Web adicionando ou removendo controlos de servidor.

Um catálogo é simplesmente uma lista de um ou mais controlos de servidor Web disponíveis (incluindo controlos WebPart, controlos ASP.NET servidores e controlos personalizados ou de utilizador) que os utilizadores podem adicionar a uma página Web. Um catálogo tem várias características comuns, incluindo texto de instruções para utilizadores finais; texto para descrever cada controlo de servidor; controlos auxiliares para selecionar os controlos do servidor e adicioná-los à página; um cabeçalho, rodapé e borda comuns; e vários atributos de estilo.

Existem três tipos de CatalogPart controlos fornecidos no conjunto de controlos Web Parts, conforme descrito na tabela seguinte. Cada tipo de CatalogPart controlo contém controlos de servidor que são adicionados a uma página a partir de uma fonte diferente.

A CatalogPart classe herda da classe base Part , pelo que tem o comportamento comum dos controlos de outras partes no conjunto de controlos Web Parts. Além disso, adiciona alguns membros úteis para a funcionalidade do catálogo. A DisplayTitle propriedade recebe a cadeia real que está a ser exibida como título do controlo. O valor desta propriedade pode ser o mesmo que o valor da propriedade Title ou, se nenhum valor foi atribuído a essa propriedade, um valor padrão fornecido pelo Quadro .NET. As WebPartManager propriedades e Zone fornecem ambas acesso conveniente aos dois objetos essenciais que controlam o ciclo de vida de um CatalogPart controlo: o WebPartManager controlo e a CatalogZoneBase zona que contém o CatalogPart controlo, respetivamente.

A CatalogPart aula inclui também vários métodos. O GetAvailableWebPartDescriptions método é declarado como um método abstrato que deve ser implementado pelos herdeiros. O seu objetivo é devolver uma coleção de descrições dos controlos no catálogo. Um método relacionado, GetWebPart, também é declarado abstrato e deve ser implementado pelos herdeiros. Este método destina-se a devolver uma instância de um WebPart controlo baseada numa descrição que é passada ao método como parâmetro.

Notas para Implementadores

Como a CatalogPart disciplina é abstrata, não podes usá-la diretamente numa página Web. O conjunto de controlos Web Parts fornece três CatalogPart controlos (listados na tabela na secção de Observações deste tópico) que derivam da classe base e que podem ser usados nas páginas Web Parts. Estes controlos devem fornecer a maioria das funcionalidades necessárias para criar catálogos de controlos de servidores Web. No entanto, pode ter necessidades especializadas que exigiriam o desenvolvimento de um controlo personalizado CatalogPart . Por exemplo, pode criar um tipo especial de CatalogPart controlo que disponibiliza os controlos do servidor através de um serviço Web, ou diretamente a partir de uma base de dados. Para isso, tens de herdar da CatalogPart turma. Deve também sobrescrever o abstract GetAvailableWebPartDescriptions() e GetWebPart(WebPartDescription) os métodos para fornecer uma implementação que devolve os WebPart outros controlos de servidor e as suas descrições. Também vai precisar de métodos para carregar os vários controlos do servidor a partir da sua base de dados ou serviço Web.

Ver também

• CatalogZoneBase
• Guia: Desenvolvimento e Utilização de um Controlo de Servidor Personalizado
• Guia: Alterar os Modos de Visualização numa Página de Web Parts
• ASP.NET Controlos de Web Parts