CatalogPart Class

Reference

Definition

Namespace:: System.Web.UI.WebControls.WebParts

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Serves as the base class for controls that reside in CatalogZoneBase zones, and that provide catalogs of available Web server controls (especially WebPart controls) that users can add to a Web page.

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

Inheritance: Object

Control

WebControl

Panel

Part
CatalogPart

Derived: System.Web.UI.WebControls.WebParts.DeclarativeCatalogPart

System.Web.UI.WebControls.WebParts.ImportCatalogPart

System.Web.UI.WebControls.WebParts.PageCatalogPart

Attributes: BindableAttribute

Examples

The following code example demonstrates the use of the CatalogPart class. Because the class is abstract, it is not used directly in code. However, the example shows how to work with the three derived CatalogPart controls provided with the Web Parts control set to demonstrate common usage scenarios.

There are four parts to the code example:

A user control that enables you to change display modes on the Web page.
A Web page, which contains the three CatalogPart controls provided with the Web Parts control set, all declared within a CatalogZone on a Web page. The page also contains a WebPartZone control, with an AdRotator control declared in the zone.
An XML file that contains quotations displayed in the AdRotator control on the Web page.
An explanation of how to run the example.

The first part of this code example is the user control that enables users to change display modes on a Web page. You should save this code in a file named DisplayModeMenuCS.ascx or DisplayModeMenuVB.ascx (depending on which language you are using). For details about display modes and a description of the source code in this control, see 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>

The second part of the code example is the Web page. The page contains a CatalogZone control, and within the child <zonetemplate> element, each of the three CatalogPart controls provided with the Web Parts control set is declared. Some attribute are set on the DeclarativeCatalogPart control, and also in the <script> section of the page, the attributes on that control are accessed programmatically. The control contains one child control that a user can add to the page: a standard Calendar control. The CatalogZone and CatalogPart control will only be visible when the user switches the page to catalog display mode.

The page also contains a WebPartZone control, and within its child <zonetemplate> element is an AdRotator control that displays alternating messages from an XML file. If a user closes the control by clicking its close verb when the page is displayed, the control is added to the page catalog, and the user can reopen the control by switching the page into catalog display mode, accessing the PageCatalogPart control, and adding back the closed control.

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

The third part of the code example is the XML file. This file is a source file for the AdRotator control that is declared on the page. The file contains favorite quotations, which the control periodically rotates and displays. Copy the following content into a text editor, and save the file as 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>

To run the code example, load the Web page in a browser. Use the Display Modes drop-down control to select Catalog and switch the page to catalog display mode. Notice the effects of the various property values that were set on the DeclarativeCatalogPart control that contains the Calendar control. You can select the check box next to the Calendar control, and click Add to add it to the page. If you click the Display DeclarativeCatalogPart Properties button, the values of the properties for that control are displayed. You can click Close to return the page to normal browse mode and see the added control on the page. Now go to the verbs menu on the AdRotator control (represented by the downward arrow in the title bar) and click Close. The control is closed and added to the page catalog. Switch the page into catalog display mode again, and click the Page Catalog hyperlink to display the PageCatalogPart control. Note that the AdRotator control is referenced there by its title, Favorite Quotes. Select the Favorite Quotes control, and click the Add button to add the control back to the page. Click the Close button to return the page to browse mode.

Note

The ImportCatalogPart control is also declared on this page, but a sample showing how to import controls is more involved, so full use of the control is not demonstrated in this code example. To see a full working example, see the class overview documents for the ImportCatalogPart class or the CatalogZone class.

Remarks

The CatalogPart class is a base class for special controls that reside in CatalogZoneBase zones. These derived CatalogPart controls provide catalogs of Web server controls that end users can add to a Web page. Use CatalogPart controls in a Web application when you want to provide end users with the flexibility to change the functionality of a Web page by adding or removing server controls.

A catalog is simply a list of one or more available Web server controls (including WebPart controls, ASP.NET server controls, and custom or user controls) that users can add to a Web page. A catalog has a number of common characteristics, including instruction text for end users; text to describe each server control; helper controls to select the server controls and add them to the page; a common header, footer, and border; and a number of style attributes.

There are three types of CatalogPart controls provided with the Web Parts control set, as described in the following table. Each type of CatalogPart control contains server controls that are added to a page from a different source.

Important

Controls that inherit from the CatalogPart class can reside only in zones derived from the CatalogZoneBase class.

Control	Description
PageCatalogPart	Contains controls that have been closed on a page, and that can be reopened (added back to the page) by users. The controls in this type of catalog are controls that were already added to the page from another source, and were then closed by a user.
DeclarativeCatalogPart	Contains server controls declared within a DeclarativeCatalogPart control, which is itself contained in a CatalogZoneBase zone in the markup of a Web page.
ImportCatalogPart	Provides the user interface (UI) for a user to upload a control's definition file (an XML file defined by a schema, that contains state information) to a catalog, so that the control can be added to a Web page. The controls themselves do not appear in this type of catalog; the catalog is just a mechanism for accessing the definition files for external controls so they can be added to a page.

The CatalogPart class inherits from the base Part class, so that it has the common behavior of other part controls in the Web Parts control set. In addition, it adds some members that are useful for the catalog functionality. The DisplayTitle property gets the actual string that is currently being displayed as the title of the control. The value of this property can be the same as the value of the Title property or, if no value has been assigned to that property, a default value supplied by the .NET Framework. The WebPartManager and Zone properties both provide convenient access to the two essential objects that control the life cycle of a CatalogPart control: the WebPartManager control, and the CatalogZoneBase zone that contains the CatalogPart control, respectively.

The CatalogPart class also contains several methods. The GetAvailableWebPartDescriptions method is declared as an abstract method that must be implemented by inheritors. Its intended purpose is to return a collection of descriptions of the controls in the catalog. A related method, GetWebPart, is also declared as abstract and must be implemented by inheritors. This method is intended to return an instance of a WebPart control based on a description that is passed to the method as a parameter.

Notes to Implementers

Because the CatalogPart class is abstract, you cannot use it directly on a Web page. The Web Parts control set provides three CatalogPart controls (listed in the table in the Remarks section of this topic) that derive from the base class and that can be used on Web Parts pages. These controls should provide most of the features needed to create catalogs of Web server controls. However, you might have specialized needs that would require developing a custom CatalogPart control. For example, you can create a special type of CatalogPart control that makes server controls available through a Web service, or directly from a database. To do this, you must inherit from the CatalogPart class. You must also override the abstract GetAvailableWebPartDescriptions() and GetWebPart(WebPartDescription) methods to provide an implementation that returns the WebPart or other server controls, and their descriptions. You will also need methods to load the various server controls from your database or Web service.

Constructors

CatalogPart()

Initializes the class for use by an inherited class instance. This constructor can only be called by an inherited class.

Properties

AccessKey	Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl)
Adapter	Gets the browser-specific adapter for the control. (Inherited from Control)
AppRelativeTemplateSourceDirectory	Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control)
Attributes	Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl)
BackColor	Gets or sets the background color of the Web server control. (Inherited from WebControl)
BackImageUrl	Gets or sets the URL of the background image for the panel control. (Inherited from Panel)
BindingContainer	Gets the control that contains this control's data binding. (Inherited from Control)
BorderColor	Gets or sets the border color of the Web control. (Inherited from WebControl)
BorderStyle	Gets or sets the border style of the Web server control. (Inherited from WebControl)
BorderWidth	Gets or sets the border width of the Web server control. (Inherited from WebControl)
ChildControlsCreated	Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control)
ChromeState	Gets or sets whether a part control is in a minimized or normal state. (Inherited from Part)
ChromeType	Gets or sets the type of border that frames a Web Parts control. (Inherited from Part)
ClientID	Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control)
ClientIDMode	Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control)
ClientIDSeparator	Gets a character value representing the separator character used in the ClientID property. (Inherited from Control)
Context	Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control)
Controls	Gets a ControlCollection object that contains the child controls for a specified server control in the user interface hierarchy. (Inherited from Part)
ControlStyle	Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl)
ControlStyleCreated	Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from WebControl)
CssClass	Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl)
DataItemContainer	Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control)
DataKeysContainer	Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control)
DefaultButton	Gets or sets the identifier for the default button that is contained in the Panel control. (Inherited from Panel)
Description	Gets or sets a brief phrase that summarizes what the part control does, for use in ToolTips and catalogs of part controls. (Inherited from Part)
DesignMode	Gets a value indicating whether a control is being used on a design surface. (Inherited from Control)
Direction	Gets or sets the direction in which to display controls that include text in a Panel control. (Inherited from Panel)
DisplayTitle	Gets a string that contains the actual current title of a CatalogPart control.
Enabled	Gets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl)
EnableTheming	Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl)
EnableViewState	Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control)
Events	Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control)
Font	Gets the font properties associated with the Web server control. (Inherited from WebControl)
ForeColor	Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl)
GroupingText	Gets or sets the caption for the group of controls that is contained in the panel control. (Inherited from Panel)
HasAttributes	Gets a value indicating whether the control has attributes set. (Inherited from WebControl)
HasChildViewState	Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control)
Height	Gets or sets the height of the Web server control. (Inherited from WebControl)
HorizontalAlign	Gets or sets the horizontal alignment of the contents within the panel. (Inherited from Panel)
ID	Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control)
IdSeparator	Gets the character used to separate control identifiers. (Inherited from Control)
IsChildControlStateCleared	Gets a value indicating whether controls contained within this control have control state. (Inherited from Control)
IsEnabled	Gets a value indicating whether the control is enabled. (Inherited from WebControl)
IsTrackingViewState	Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control)
IsViewStateEnabled	Gets a value indicating whether view state is enabled for this control. (Inherited from Control)
LoadViewStateByID	Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control)
NamingContainer	Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. (Inherited from Control)
Page	Gets a reference to the Page instance that contains the server control. (Inherited from Control)
Parent	Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control)
RenderingCompatibility	Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control)
ScrollBars	Gets or sets the visibility and position of scroll bars in a Panel control. (Inherited from Panel)
Site	Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control)
SkinID	Gets or sets the skin to apply to the control. (Inherited from WebControl)
Style	Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from WebControl)
SupportsDisabledAttribute	Gets a value that indicates whether the control should set the `disabled` attribute of the rendered HTML element to "disabled" when the control's IsEnabled property is `false`. (Inherited from Panel)
TabIndex	Gets or sets the tab index of the Web server control. (Inherited from WebControl)
TagKey	Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from WebControl)
TagName	Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl)
TemplateControl	Gets or sets a reference to the template that contains this control. (Inherited from Control)
TemplateSourceDirectory	Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control)
Title	Gets or sets the title of a part control. (Inherited from Part)
ToolTip	Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl)
UniqueID	Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control)
ValidateRequestMode	Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control)
ViewState	Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control)
ViewStateIgnoresCase	Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control)
ViewStateMode	Gets or sets the view-state mode of this control. (Inherited from Control)
Visible	Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control)
WebPartManager	Gets a reference to the current instance of the WebPartManager class.
Width	Gets or sets the width of the Web server control. (Inherited from WebControl)
Wrap	Gets or sets a value indicating whether the content wraps within the panel. (Inherited from Panel)
Zone	Gets a reference to the CatalogZoneBase zone that contains a CatalogPart control.

Methods

AddAttributesToRender(HtmlTextWriter)	Adds information about the background image, alignment, wrap, and direction to the list of attributes to render. (Inherited from Panel)
AddedControl(Control, Int32)	Called after a child control is added to the Controls collection of the Control object. (Inherited from Control)
AddParsedSubObject(Object)	Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control)
ApplyStyle(Style)	Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers. (Inherited from WebControl)
ApplyStyleSheetSkin(Page)	Applies the style properties defined in the page style sheet to the control. (Inherited from Control)
BeginRenderTracing(TextWriter, Object)	Begins design-time tracing of rendering data. (Inherited from Control)
BuildProfileTree(String, Boolean)	Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control)
ClearCachedClientID()	Sets the cached ClientID value to `null`. (Inherited from Control)
ClearChildControlState()	Deletes the control-state information for the server control's child controls. (Inherited from Control)
ClearChildState()	Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control)
ClearChildViewState()	Deletes the view-state information for all the server control's child controls. (Inherited from Control)
ClearEffectiveClientIDMode()	Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control)
CopyBaseAttributes(WebControl)	Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers. (Inherited from WebControl)
CreateChildControls()	Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (Inherited from Control)
CreateControlCollection()	Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control)
CreateControlStyle()	Creates a style object that is used internally by the Panel control to implement all style related properties. (Inherited from Panel)
DataBind()	Binds a data source to the invoked server control and all its child controls. (Inherited from Part)
DataBind(Boolean)	Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control)
DataBindChildren()	Binds a data source to the server control's child controls. (Inherited from Control)
Dispose()	Enables a server control to perform final clean up before it is released from memory. (Inherited from Control)
EndRenderTracing(TextWriter, Object)	Ends design-time tracing of rendering data. (Inherited from Control)
EnsureChildControls()	Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control)
EnsureID()	Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control)
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
FindControl(String, Int32)	Searches the current naming container for a server control with the specified `id` and an integer, specified in the `pathOffset` parameter, which aids in the search. You should not override this version of the FindControl method. (Inherited from Control)
FindControl(String)	Searches the current naming container for a server control with the specified `id` parameter. (Inherited from Control)
Focus()	Sets input focus to a control. (Inherited from Control)
GetAvailableWebPartDescriptions()	Returns a collection of descriptions of the available WebPart controls in a catalog.
GetDesignModeState()	Retrieves the current state of a CatalogPart control's parent zone.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetRouteUrl(Object)	Gets the URL that corresponds to a set of route parameters. (Inherited from Control)
GetRouteUrl(RouteValueDictionary)	Gets the URL that corresponds to a set of route parameters. (Inherited from Control)
GetRouteUrl(String, Object)	Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control)
GetRouteUrl(String, RouteValueDictionary)	Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control)
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetUniqueIDRelativeTo(Control)	Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control)
GetWebPart(WebPartDescription)	Retrieves from a catalog the WebPart control that is referenced by the WebPartDescription object passed to the method.
HasControls()	Determines if the server control contains any child controls. (Inherited from Control)
HasEvents()	Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control)
IsLiteralContent()	Determines if the server control holds only literal content. (Inherited from Control)
LoadControlState(Object)	Restores control-state information from a previous page request that was saved by the SaveControlState() method. (Inherited from Control)
LoadViewState(Object)	Restores view-state information from a previous request that was saved with the SaveViewState() method. (Inherited from WebControl)
MapPathSecure(String)	Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
MergeStyle(Style)	Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers. (Inherited from WebControl)
OnBubbleEvent(Object, EventArgs)	Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control)
OnDataBinding(EventArgs)	Raises the DataBinding event. (Inherited from Control)
OnInit(EventArgs)	Raises the Init event. (Inherited from Control)
OnLoad(EventArgs)	Raises the Load event. (Inherited from Control)
OnPreRender(EventArgs)	Raises the PreRender event.
OnUnload(EventArgs)	Raises the Unload event. (Inherited from Control)
OpenFile(String)	Gets a Stream used to read a file. (Inherited from Control)
RaiseBubbleEvent(Object, EventArgs)	Assigns any sources of the event and its information to the control's parent. (Inherited from Control)
RemovedControl(Control)	Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control)
Render(HtmlTextWriter)	Renders the control to the specified HTML writer. (Inherited from WebControl)
RenderBeginTag(HtmlTextWriter)	Renders the HTML opening tag of the Panel control to the specified writer. (Inherited from Panel)
RenderChildren(HtmlTextWriter)	Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control)
RenderContents(HtmlTextWriter)	Renders the contents of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl)
RenderControl(HtmlTextWriter, ControlAdapter)	Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control)
RenderControl(HtmlTextWriter)	Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control)
RenderEndTag(HtmlTextWriter)	Renders the HTML closing tag of the Panel control into the specified writer. (Inherited from Panel)
ResolveAdapter()	Gets the control adapter responsible for rendering the specified control. (Inherited from Control)
ResolveClientUrl(String)	Gets a URL that can be used by the browser. (Inherited from Control)
ResolveUrl(String)	Converts a URL into one that is usable on the requesting client. (Inherited from Control)
SaveControlState()	Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control)
SaveViewState()	Saves any state that was modified after the TrackViewState() method was invoked. (Inherited from WebControl)
SetDesignModeState(IDictionary)	Sets design-time data for a control.
SetRenderMethodDelegate(RenderMethod)	Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control)
SetTraceData(Object, Object, Object)	Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value. (Inherited from Control)
SetTraceData(Object, Object)	Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. (Inherited from Control)
ToString()	Returns a string that represents the current object. (Inherited from Object)
TrackViewState()	Causes the control to track changes to its view state so they can be stored in the object's ViewState property. (Inherited from WebControl)

Events

DataBinding	Occurs when the server control binds to a data source. (Inherited from Control)
Disposed	Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control)
Init	Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control)
Load	Occurs when the server control is loaded into the Page object. (Inherited from Control)
PreRender	Occurs after the Control object is loaded but prior to rendering. (Inherited from Control)
Unload	Occurs when the server control is unloaded from memory. (Inherited from Control)

Explicit Interface Implementations

IAttributeAccessor.GetAttribute(String)	Gets an attribute of the Web control with the specified name. (Inherited from WebControl)
IAttributeAccessor.SetAttribute(String, String)	Sets an attribute of the Web control to the specified name and value. (Inherited from WebControl)
ICompositeControlDesignerAccessor.RecreateChildControls()	Allows the developer of a designer for a composite part control to recreate the control's child controls on the design surface. (Inherited from Part)
IControlBuilderAccessor.ControlBuilder	For a description of this member, see ControlBuilder. (Inherited from Control)
IControlDesignerAccessor.GetDesignModeState()	For a description of this member, see GetDesignModeState(). (Inherited from Control)
IControlDesignerAccessor.SetDesignModeState(IDictionary)	For a description of this member, see SetDesignModeState(IDictionary). (Inherited from Control)
IControlDesignerAccessor.SetOwnerControl(Control)	For a description of this member, see SetOwnerControl(Control). (Inherited from Control)
IControlDesignerAccessor.UserData	For a description of this member, see UserData. (Inherited from Control)
IDataBindingsAccessor.DataBindings	For a description of this member, see DataBindings. (Inherited from Control)
IDataBindingsAccessor.HasDataBindings	For a description of this member, see HasDataBindings. (Inherited from Control)
IExpressionsAccessor.Expressions	For a description of this member, see Expressions. (Inherited from Control)
IExpressionsAccessor.HasExpressions	For a description of this member, see HasExpressions. (Inherited from Control)
IParserAccessor.AddParsedSubObject(Object)	For a description of this member, see AddParsedSubObject(Object). (Inherited from Control)

Extension Methods

FindDataSourceControl(Control)	Returns the data source that is associated with the data control for the specified control.
FindFieldTemplate(Control, String)	Returns the field template for the specified column in the specified control's naming container.
FindMetaTable(Control)	Returns the metatable object for the containing data control.
GetDefaultValues(INamingContainer)	Gets the collection of the default values for the specified data control.
GetMetaTable(INamingContainer)	Gets the table metadata for the specified data control.
SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>)	Sets the table metadata and default value mapping for the specified data control.
SetMetaTable(INamingContainer, MetaTable, Object)	Sets the table metadata and default value mapping for the specified data control.
SetMetaTable(INamingContainer, MetaTable)	Sets the table metadata for the specified data control.
TryGetMetaTable(INamingContainer, MetaTable)	Determines whether table metadata is available.
EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>)	Enables Dynamic Data behavior for the specified data control.
EnableDynamicData(INamingContainer, Type, Object)	Enables Dynamic Data behavior for the specified data control.
EnableDynamicData(INamingContainer, Type)	Enables Dynamic Data behavior for the specified data control.

Applies to

Share via