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 exemplo de código a seguir demonstra o uso da CatalogPart classe . Como a classe é abstrata, ela não é usada diretamente no código. No entanto, o exemplo mostra como trabalhar com os três controles derivados CatalogPart fornecidos com o conjunto de controle de Web Parts para demonstrar cenários comuns de uso.

Há quatro partes no exemplo de código:

• Um controle de usuário que permite alterar os modos de exibição na página da Web.

• Uma página da Web, que contém os três CatalogPart controles fornecidos com o conjunto de controle de Web Parts, todos declarados em uma CatalogZone página da Web. A página também contém um WebPartZone controle , com um AdRotator controle declarado na zona.

• Um arquivo XML que contém aspas exibidas no AdRotator controle na página da Web.

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

A primeira parte desse exemplo de código é o controle de usuário que permite que os usuários alterem os modos de exibição em uma página da Web. Você deve salvar esse código em um arquivo chamado DisplayModeMenuCS.ascx ou DisplayModeMenuVB.ascx (dependendo de qual idioma você está usando). Para obter detalhes sobre modos de exibição e uma descrição do código-fonte nesse controle, consulte Passo a passo: alterando modos de exibição em uma página de Web Parts.

<%@ 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 de código é a página da Web. A página contém um controle e, dentro do elemento filho<zonetemplate>, cada um CatalogZone dos três CatalogPart controles fornecidos com o conjunto de controle de Web Parts é declarado. Alguns atributos são definidos no DeclarativeCatalogPart controle e, também na <seção de script> da página, os atributos nesse controle são acessados programaticamente. O controle contém um controle filho que um usuário pode adicionar à página: um controle padrão Calendar . O CatalogZone controle e CatalogPart só ficará visível quando o usuário alternar a página para o modo de exibição do catálogo.

A página também contém um WebPartZone controle e, dentro de seu elemento filho <zonetemplate> , há um AdRotator controle que exibe mensagens alternadas de um arquivo XML. Se um usuário fechar o controle clicando em seu verbo de fechamento quando a página é exibida, o controle é adicionado ao catálogo de páginas e o usuário pode reabrir o controle alternando a página para o modo de exibição de catálogo, acessando o PageCatalogPart controle e adicionando o controle 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 arquivo XML. Esse arquivo é um arquivo de origem para o AdRotator controle declarado na página. O arquivo contém aspas favoritas, que o controle gira e exibe periodicamente. Copie o conteúdo a seguir em um editor de texto e salve o arquivo 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 da Web em um navegador. Use o controle suspenso Modos de Exibição para selecionar Catálogo e alternar a página para o modo de exibição do catálogo. Observe os efeitos dos vários valores de propriedade que foram definidos no DeclarativeCatalogPart controle que contém o Calendar controle . Você pode selecionar a caixa marcar ao lado do Calendar controle e clicar em Adicionar para adicioná-la à página. Se você clicar no botão Exibir Propriedades DeclarativeCatalogPart , os valores das propriedades desse controle serão exibidos. Você pode clicar em Fechar para retornar a página ao modo de navegação normal e ver o controle adicionado na página. Agora, vá para o menu de verbos no AdRotator controle (representado pela seta para baixo na barra de título) e clique em Fechar. O controle é fechado e adicionado ao catálogo de páginas. Alterne a página para o modo de exibição do catálogo novamente e clique no hiperlink Catálogo de Páginas para exibir o PageCatalogPart controle. Observe que o AdRotator controle é referenciado por seu título, Cotações Favoritas. Selecione o controle Cotações Favoritas e clique no botão Adicionar para adicionar o controle de volta à página. Clique no botão Fechar para retornar a página para o modo de navegação.

Comentários

A CatalogPart classe é uma classe base para controles especiais que residem em CatalogZoneBase zonas. Esses controles derivados CatalogPart fornecem catálogos de controles de servidor Web que os usuários finais podem adicionar a uma página da Web. Use CatalogPart controles em um aplicativo Web quando quiser fornecer aos usuários finais a flexibilidade para alterar a funcionalidade de uma página da Web adicionando ou removendo controles de servidor.

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

Há três tipos de CatalogPart controles fornecidos com o conjunto de controle de Web Parts, conforme descrito na tabela a seguir. Cada tipo de controle contém controles de CatalogPart servidor que são adicionados a uma página de uma fonte diferente.

A CatalogPart classe herda da classe base Part , para que ela tenha o comportamento comum de outros controles de parte no conjunto de controles de Web Parts. Além disso, ele adiciona alguns membros que são úteis para a funcionalidade de catálogo. A DisplayTitle propriedade obtém a cadeia de caracteres real que está sendo exibida no momento como o título do controle. O valor dessa propriedade pode ser o mesmo que o valor da Title propriedade ou, se nenhum valor tiver sido atribuído a essa propriedade, um valor padrão fornecido pelo .NET Framework. As WebPartManager propriedades e Zone fornecem acesso conveniente aos dois objetos essenciais que controlam o ciclo de vida de um CatalogPart controle: o WebPartManager controle e a CatalogZoneBase zona que contém o CatalogPart controle, respectivamente.

A CatalogPart classe também contém vários métodos. O GetAvailableWebPartDescriptions método é declarado como um método abstrato que deve ser implementado por herdadores. Sua finalidade pretendida é retornar uma coleção de descrições dos controles no catálogo. Um método relacionado, GetWebPart, também é declarado como abstrato e deve ser implementado por herdadores. Esse método destina-se a retornar uma instância de um WebPart controle com base em uma descrição passada para o método como um parâmetro.

Notas aos Implementadores

Como a CatalogPart classe é abstrata, você não pode usá-la diretamente em uma página da Web. O conjunto de controles de Web Parts fornece três CatalogPart controles (listados na tabela na seção Comentários deste tópico) que derivam da classe base e que podem ser usados em páginas de Web Parts. Esses controles devem fornecer a maioria dos recursos necessários para criar catálogos de controles de servidor Web. No entanto, você pode ter necessidades especializadas que exigiriam o desenvolvimento de um controle personalizado CatalogPart . Por exemplo, você pode criar um tipo especial de controle que disponibiliza controles de CatalogPart servidor por meio de um serviço Web ou diretamente de um banco de dados. Para fazer isso, você deve herdar da CatalogPart classe . Você também deve substituir os métodos abstract GetAvailableWebPartDescriptions() e GetWebPart(WebPartDescription) para fornecer uma implementação que retorna o WebPart ou outros controles de servidor e suas descrições. Você também precisará de métodos para carregar os vários controles de servidor de seu banco de dados ou serviço Web.

Construtores

Propriedades

Métodos

Eventos

Implantações explícitas de interface

Métodos de Extensão

Aplica-se a

Confira também

• CatalogZoneBase
• Passo a passo: desenvolvendo e usando um controle de servidor personalizado
• Passo a passo: alterando modos de exibição em uma página de Web Parts
• Controles de Web Parts do ASP.NET