CatalogPart Klass

Definition

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

Arv

Object

Control

WebControl

Panel

Part

CatalogPart

Härledda

System.Web.UI.WebControls.WebParts.DeclarativeCatalogPart

System.Web.UI.WebControls.WebParts.ImportCatalogPart

System.Web.UI.WebControls.WebParts.PageCatalogPart

Attribut

BindableAttribute

Exempel

I följande kodexempel visas hur klassen används CatalogPart . Eftersom klassen är abstrakt används den inte direkt i kod. Exemplet visar dock hur du arbetar med de tre härledda CatalogPart kontrollerna som tillhandahålls med webbdelskontrolluppsättningen för att demonstrera vanliga användningsscenarier.

Kodexemplet har fyra delar:

• En användarkontroll som gör att du kan ändra visningslägen på webbsidan.

• En webbsida, som innehåller de tre CatalogPart kontrollerna som medföljer kontrolluppsättningen Webbdelar, som alla deklareras i en CatalogZone på en webbsida. Sidan innehåller också en WebPartZone kontroll, med en AdRotator kontroll deklarerad i zonen.

• En XML-fil som innehåller citattecken som visas i AdRotator kontrollen på webbsidan.

• En förklaring av hur du kör exemplet.

Den första delen av det här kodexemplet är användarkontrollen som gör det möjligt för användare att ändra visningslägen på en webbsida. Du bör spara den här koden i en fil med namnet DisplayModeMenuCS.ascx eller DisplayModeMenuVB.ascx (beroende på vilket språk du använder). Mer information om visningslägen och en beskrivning av källkoden i den här kontrollen finns i Genomgång: Ändra visningslägen på en webbsida.

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

Den andra delen av kodexemplet är webbsidan. Sidan innehåller en CatalogZone kontroll, och i det underordnade <zonetemplate> elementet deklareras var och en av de tre CatalogPart kontrollerna som medföljer kontrolluppsättningen Webbdelar. Vissa attribut anges på DeclarativeCatalogPart kontrollen, och även i <skriptavsnittet> på sidan används attributen för den kontrollen programmatiskt. Kontrollen innehåller en underordnad kontroll som en användare kan lägga till på sidan: en standardkontroll Calendar . Kontrollen CatalogZone och CatalogPart visas endast när användaren växlar sidan till katalogvisningsläge.

Sidan innehåller också en WebPartZone kontroll, och i dess underordnade <zonetemplate> element finns en AdRotator kontroll som visar alternerande meddelanden från en XML-fil. Om en användare stänger kontrollen genom att klicka på dess nära verb när sidan visas läggs kontrollen till i sidkatalogen och användaren kan öppna kontrollen igen genom att växla sidan till katalogvisningsläge, komma åt PageCatalogPart kontrollen och lägga till den stängda kontrollen igen.

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

Den tredje delen av kodexemplet är XML-filen. Den här filen är en källfil för kontrollen AdRotator som deklareras på sidan. Filen innehåller favoritcitat, som kontrollen roterar och visar regelbundet. Kopiera följande innehåll till en textredigerare och spara filen som 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>

Om du vill köra kodexemplet läser du in webbsidan i en webbläsare. Använd listrutan Visningslägen för att välja Katalog och växla sidan till katalogvisningsläge. Observera effekterna av de olika egenskapsvärden som har angetts för kontrollen DeclarativeCatalogPart som innehåller Calendar kontrollen. Du kan markera kryssrutan bredvid Calendar kontrollen och klicka på Lägg till för att lägga till den på sidan. Om du klickar på knappen Visa deklarativaCatalogPart-egenskaper visas värdena för egenskaperna för kontrollen. Du kan klicka på Stäng för att återgå till normalt sökläge och se den tillagda kontrollen på sidan. Gå nu till verbmenyn på AdRotator kontrollen (representeras av nedåtpilen i namnlisten) och klicka på Stäng. Kontrollen stängs och läggs till i sidkatalogen. Växla sidan till katalogvisningsläge igen och klicka på hyperlänken Sidkatalog för att visa PageCatalogPart kontrollen. Observera att kontrollen AdRotator refereras där med dess rubrik, Favorit citattecken. Välj kontrollen Favorit citattecken och klicka på knappen Lägg till för att lägga till kontrollen på sidan igen. Klicka på knappen Stäng för att returnera sidan för att bläddra.

Kommentarer

Klassen CatalogPart är en basklass för särskilda kontroller som finns i CatalogZoneBase zoner. Dessa härledda CatalogPart kontroller tillhandahåller kataloger med webbserverkontroller som slutanvändarna kan lägga till på en webbsida. Använd CatalogPart kontroller i ett webbprogram när du vill ge slutanvändarna flexibiliteten att ändra funktionaliteten på en webbsida genom att lägga till eller ta bort serverkontroller.

En katalog är helt enkelt en lista över en eller flera tillgängliga webbserverkontroller (inklusive WebPart kontroller, ASP.NET serverkontroller och anpassade kontroller eller användarkontroller) som användarna kan lägga till på en webbsida. En katalog har ett antal vanliga egenskaper, inklusive instruktionstext för slutanvändare. text för att beskriva varje serverkontroll. hjälpkontroller för att välja serverkontroller och lägga till dem på sidan. ett gemensamt sidhuvud, sidfot och kantlinje; och ett antal formatattribut.

Det finns tre typer av CatalogPart kontroller med kontrolluppsättningen Webbdelar enligt beskrivningen i följande tabell. Varje typ av CatalogPart kontroll innehåller serverkontroller som läggs till på en sida från en annan källa.

Klassen CatalogPart ärver från basklassen Part , så att den har det vanliga beteendet för andra delkontroller i kontrolluppsättningen Webbdelar. Dessutom lägger den till några medlemmar som är användbara för katalogfunktionerna. Egenskapen DisplayTitle hämtar den faktiska sträng som för närvarande visas som kontrollens rubrik. Värdet för den här egenskapen kan vara detsamma som värdet för egenskapen Title eller, om inget värde har tilldelats egenskapen, ett standardvärde som tillhandahålls av .NET Framework. Egenskaperna WebPartManager och Zone ger både bekväm åtkomst till de två viktiga objekten som styr livscykeln för en CatalogPart kontroll: WebPartManager kontrollen respektive CatalogZoneBase zonen som innehåller CatalogPart kontrollen.

Klassen CatalogPart innehåller också flera metoder. Metoden GetAvailableWebPartDescriptions deklareras som en abstrakt metod som måste implementeras av ärver. Syftet är att returnera en samling beskrivningar av kontrollerna i katalogen. En relaterad metod, GetWebPart, deklareras också som abstrakt och måste implementeras av arvtagare. Den här metoden är avsedd att returnera en instans av en WebPart kontroll baserat på en beskrivning som skickas till metoden som en parameter.

Anteckningar till implementerare

CatalogPart Eftersom klassen är abstrakt kan du inte använda den direkt på en webbsida. Kontrolluppsättningen Webbdelar innehåller tre CatalogPart kontroller (som visas i tabellen i avsnittet Kommentarer i det här avsnittet) som härleds från basklassen och som kan användas på webbsidor. Dessa kontroller bör tillhandahålla de flesta av de funktioner som behövs för att skapa kataloger med webbserverkontroller. Du kan dock ha särskilda behov som kräver att du utvecklar en anpassad CatalogPart kontroll. Du kan till exempel skapa en särskild typ av CatalogPart kontroll som gör serverkontroller tillgängliga via en webbtjänst eller direkt från en databas. För att göra detta måste du ärva från CatalogPart klassen. Du måste också åsidosätta abstrakta GetAvailableWebPartDescriptions() metoder och GetWebPart(WebPartDescription) metoder för att tillhandahålla en implementering som returnerar WebPart eller andra serverkontroller och deras beskrivningar. Du behöver också metoder för att läsa in de olika serverkontrollerna från databasen eller webbtjänsten.

Se även

• CatalogZoneBase
• Genomgång: Utveckla och använda en anpassad serverkontroll
• Genomgång: Ändra visningslägen på en webbdelssida
• ASP.NET webbdelskontroller