CatalogPart Класс

Определение

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

Наследование

Object

Control

WebControl

Panel

Part

CatalogPart

Производный

System.Web.UI.WebControls.WebParts.DeclarativeCatalogPart

System.Web.UI.WebControls.WebParts.ImportCatalogPart

System.Web.UI.WebControls.WebParts.PageCatalogPart

Атрибуты

BindableAttribute

Примеры

В следующем примере кода показано использование CatalogPart класса. Так как класс является абстрактным, он не используется непосредственно в коде. Однако в примере показано, как работать с тремя производными CatalogPart элементами управления, предоставленными с набором элементов управления веб-частей, чтобы продемонстрировать распространенные сценарии использования.

В примере кода есть четыре части:

• Пользовательский элемент управления, позволяющий изменять режимы отображения на веб-странице.

• Веб-страница, содержащая три CatalogPart элемента управления, предоставленные набором элементов управления веб-частей, все объявлены на CatalogZone веб-странице. Страница также содержит элемент управления с элементом WebPartZone управления, объявленным AdRotator в зоне.

• XML-файл, содержащий кавычки, отображаемые в элементе AdRotator управления на веб-странице.

• Описание запуска примера.

Первая часть этого примера кода — это пользовательский элемент управления, позволяющий пользователям изменять режимы отображения на веб-странице. Этот код следует сохранить в файле DisplayModeMenuCS.ascx или DisplayModeMenuVB.ascx (в зависимости от используемого языка). Дополнительные сведения о режимах отображения и описании исходного кода в этом элементе управления см. в пошаговом руководстве. Изменение режимов отображения на странице веб-частей.

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

Второй частью примера кода является веб-страница. Страница содержит CatalogZone элемент управления, а в дочернем <zonetemplate> элементе объявляется каждый из трех CatalogPart элементов управления, предоставляемых набором элементов управления веб-частей. Некоторые атрибуты задаются в DeclarativeCatalogPart элементе управления, а также в <разделе скрипта> страницы атрибуты этого элемента управления получают доступ программно. Элемент управления содержит один дочерний элемент управления, который пользователь может добавить на страницу: стандартный Calendar элемент управления. Элемент CatalogZoneCatalogPart управления будет отображаться только в том случае, если пользователь переключает страницу в режим отображения каталога.

Страница также содержит WebPartZone элемент управления, а в его дочернем <zonetemplate> элементе — это AdRotator элемент управления, который отображает чередующиеся сообщения из XML-файла. Если пользователь закрывает элемент управления, щелкнув его закрывающую команду при отображении страницы, элемент управления добавляется в каталог страницы, а пользователь может повторно открыть элемент управления, переключив PageCatalogPart страницу в режим отображения каталога, доступ к элементу управления и добавление закрытого элемента управления.

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

Третья часть примера кода — XML-файл. Этот файл является исходным файлом для AdRotator элемента управления, объявленного на странице. Файл содержит избранные кавычки, которые элемент управления периодически поворачивает и отображает. Скопируйте следующее содержимое в текстовый редактор и сохраните файл как 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>

Чтобы запустить пример кода, загрузите веб-страницу в браузере. Используйте раскрывающийся список "Режимы отображения ", чтобы выбрать каталог и переключить страницу в режим отображения каталога. Обратите внимание на эффекты различных значений свойств, заданных в DeclarativeCatalogPart элементе управления, содержавшемся в элементе Calendar управления. Установите флажок рядом с элементом Calendar управления и нажмите кнопку "Добавить ", чтобы добавить ее на страницу. Если нажать кнопку "Свойства Display DeclarativeCatalogPart" , отображаются значения свойств для этого элемента управления. Вы можете нажать кнопку "Закрыть" , чтобы вернуть страницу в обычный режим обзора и просмотреть добавленный элемент управления на странице. Теперь перейдите в меню AdRotator команд в элементе управления (представленная стрелкой вниз в строке заголовка) и нажмите кнопку "Закрыть". Элемент управления закрывается и добавляется в каталог страниц. Снова переключите страницу в режим отображения каталога и щелкните гиперссылку каталога страниц, чтобы отобразить элемент PageCatalogPart управления. Обратите внимание, что элемент AdRotator управления ссылается на его название, избранное кавычки. Выберите элемент управления "Избранное кавычки " и нажмите кнопку "Добавить ", чтобы добавить элемент управления обратно на страницу. Нажмите кнопку "Закрыть ", чтобы вернуть страницу для просмотра в режиме обзора.

Комментарии

Класс CatalogPart — это базовый класс для специальных элементов управления, которые находятся в CatalogZoneBase зонах. Эти производные CatalogPart элементы управления предоставляют каталоги элементов управления веб-сервера, которые пользователи могут добавлять на веб-страницу. Используйте CatalogPart элементы управления в веб-приложении, если вы хотите предоставить конечным пользователям гибкость для изменения функциональности веб-страницы, добавив или удалив серверные элементы управления.

Каталог — это просто список одного или нескольких доступных элементов управления веб-сервера (включая WebPart элементы управления, ASP.NET серверные элементы управления и пользовательские элементы управления), которые пользователи могут добавлять на веб-страницу. Каталог имеет ряд общих характеристик, включая текст инструкций для конечных пользователей; текст для описания каждого элемента управления сервером; вспомогательные элементы управления, чтобы выбрать серверные элементы управления и добавить их на страницу; общие верхние, нижние колонтитулы и границы; и ряд атрибутов стиля.

Существует три типа элементов управления, предоставляемых CatalogPart набором элементов управления веб-частей, как описано в следующей таблице. Каждый тип CatalogPart элемента управления содержит серверные элементы управления, добавляемые на страницу из другого источника.

Класс CatalogPart наследует от базового Part класса, поэтому он имеет общее поведение других элементов управления в наборе элементов управления веб-частей. Кроме того, он добавляет некоторые элементы, полезные для функциональности каталога. Свойство DisplayTitle получает фактическую строку, которая в настоящее время отображается в качестве заголовка элемента управления. Значение этого свойства может совпадать со Title значением свойства или, если этому свойству не назначено значение по умолчанию, предоставленное платформой .NET Framework. Оба WebPartManagerZone свойства обеспечивают удобный доступ к двум основным объектам, которые управляют жизненным циклом CatalogPart элемента управления: WebPartManager элементом управления и CatalogZoneBase зоной, содержащей CatalogPart элемент управления соответственно.

Класс CatalogPart также содержит несколько методов. Метод GetAvailableWebPartDescriptions объявляется абстрактным методом, который должен быть реализован наследующими. Его целью является возврат коллекции описаний элементов управления в каталоге. Связанный метод, GetWebPartтакже объявляется абстрактным и должен быть реализован наследуемыми. Этот метод предназначен для возврата экземпляра WebPart элемента управления на основе описания, передаваемого методу в качестве параметра.

Примечания для тех, кто реализует этот метод

CatalogPart Так как класс является абстрактным, его нельзя использовать непосредственно на веб-странице. Набор элементов управления веб-частей предоставляет три CatalogPart элемента управления (перечисленные в таблице в разделе "Примечания" этого раздела), производные от базового класса и которые можно использовать на страницах веб-частей. Эти элементы управления должны предоставлять большую часть функций, необходимых для создания каталогов элементов управления веб-сервера. Однако у вас могут быть специализированные потребности, требующие разработки пользовательского CatalogPart элемента управления. Например, можно создать специальный тип CatalogPart элемента управления, который делает серверные элементы управления доступными через веб-службу или непосредственно из базы данных. Для этого необходимо наследовать от CatalogPart класса. Кроме того, необходимо переопределить абстрактные GetAvailableWebPartDescriptions() и GetWebPart(WebPartDescription) методы, чтобы предоставить реализацию, которая возвращает WebPart или другие серверные элементы управления и их описания. Вам также потребуются методы для загрузки различных элементов управления сервером из базы данных или веб-службы.

См. также раздел

• CatalogZoneBase
• Пошаговое руководство. Разработка и использование пользовательского элемента управления сервером
• Пошаговое руководство. Изменение режимов отображения на странице веб-частей
• элементы управления веб-частей ASP.NET