GenericWebPart 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.

Wraps server controls that are not WebPart controls so that they can appear and behave as true WebPart controls at run time.

public ref class GenericWebPart : System::Web::UI::WebControls::WebParts::WebPart

public class GenericWebPart : System.Web.UI.WebControls.WebParts.WebPart

type GenericWebPart = class
    inherit WebPart

Public Class GenericWebPart
Inherits WebPart

Inheritance: Object

Control

WebControl

Panel

Part

WebPart
GenericWebPart

Examples

The following code example demonstrates how the GenericWebPart control automatically wraps a server control that is not a WebPart control at run time.

The first part of the code example contains a Web Parts page with two WebPartZone controls. Within each zone is a standard ASP.NET server control. Because the controls are in a WebPartZone zone, they will be automatically wrapped with a GenericWebPart control when the page is compiled. So, you can declare WebPart class properties on these controls. After you load the page in a browser, if you click the Display All Property Values button, the details for each control are displayed in a label. To show how the GenericWebPart control works, the Calendar control in the first zone has some of the GenericWebPart properties set in the declarative markup of the .aspx page, whereas the BulletedList control does not. After you load the page, note the differences in the property values for the two controls, and that both have a parent GenericWebPart control.

<%@ Page Language="C#" 
  Codefile="genericwebpart.cs" 
  Inherits="genericwebpart_sample" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>GenericWebPart Example</title>
</head>
<body>
    <form id="form1" runat="server">
      <asp:WebPartManager ID="WebPartManager1" runat="server">
      </asp:WebPartManager>
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <asp:Calendar ID="Calendar1" runat="server"
            Title="My Calendar"
            Description="A calendar used as a GenericWebPart control."
            CatalogIconImageUrl="MyCatalogIcon.gif"
            TitleIconimageUrl ="MyTitleIcon.gif"
            TitleUrl="MyInfoUrl.htm" 
            Width="250"/>
        </ZoneTemplate>
      </asp:WebPartZone>
      <asp:WebPartZone ID="WebPartZone2" runat="server">
        <ZoneTemplate>
          <asp:BulletedList ID="BulletedList1" 
            Runat="server"
            DisplayMode="HyperLink">
            <asp:ListItem Value="http://msdn.microsoft.com">
              MSDN
            </asp:ListItem>
            <asp:ListItem Value="http://www.asp.net">
              ASP.NET
            </asp:ListItem>
            <asp:ListItem Value="http://www.msn.com">
              MSN
            </asp:ListItem>
          </asp:BulletedList>        
        </ZoneTemplate>
      </asp:WebPartZone>
      <hr />
      <asp:Button ID="Button1" width="200"
        runat="server" 
        Text="Display All Property Values" OnClick="Button1_Click" /> 
      <br />
      <asp:Label ID="Label2" runat="server" Text="" />
      <br />   
      <asp:Label ID="Label3" runat="server" Text="" />
    </form>
</body>
</html>

<%@ Page Language="vb" 
  Codefile="genericwebpart.vb" 
  Inherits="genericwebpart_sample" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>GenericWebPart Example</title>
</head>
<body>
    <form id="form1" runat="server">
      <asp:WebPartManager ID="WebPartManager1" runat="server">
      </asp:WebPartManager>
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <asp:Calendar ID="Calendar1" runat="server"
            Title="My Calendar"
            Description="A calendar used as a GenericWebPart control."
            CatalogIconImageUrl="MyCatalogIcon.gif"
            TitleIconimageUrl ="MyTitleIcon.gif"
            TitleUrl="MyInfoUrl.htm" 
            Width="250"/>
        </ZoneTemplate>
      </asp:WebPartZone>
      <asp:WebPartZone ID="WebPartZone2" runat="server">
        <ZoneTemplate>
          <asp:BulletedList ID="BulletedList1" 
            Runat="server"
            DisplayMode="HyperLink">
            <asp:ListItem Value="http://msdn.microsoft.com">
              MSDN
            </asp:ListItem>
            <asp:ListItem Value="http://www.asp.net">
              ASP.NET
            </asp:ListItem>
            <asp:ListItem Value="http://www.msn.com">
              MSN
            </asp:ListItem>
          </asp:BulletedList>        
        </ZoneTemplate>
      </asp:WebPartZone>
      <hr />
      <asp:Button ID="Button1" width="200"
        runat="server" 
        Text="Display All Property Values" OnClick="Button1_Click" /> 
      <br />
      <asp:Label ID="Label2" runat="server" Text="" />
      <br />   
      <asp:Label ID="Label3" runat="server" Text="" />
    </form>
</body>
</html>

The second part of the code example shows a partial class that accesses some properties of the GenericWebPart control programmatically. Notice that in the Page_Load method, the GetGenericWebPart method is used to retrieve the run-time instance of the GenericWebPart control that wraps a server control. This approach of getting a reference to the parent GenericWebPart control enables you to work programmatically with an ordinary server or user control as if it were a WebPart control at run time.

using System;
using System.Data;
using System.Configuration;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;

public partial class genericwebpart_sample : System.Web.UI.Page
{
  GenericWebPart calendarPart;
  GenericWebPart listPart;

  protected void Page_Load(Object sender, EventArgs e)
  {
    calendarPart = WebPartManager1.GetGenericWebPart(Calendar1);
    listPart = WebPartManager1.GetGenericWebPart(BulletedList1);

    if (!IsPostBack)
    {
      Label2.Text = String.Empty;
      Label3.Text = String.Empty;
    }
  }

  protected void Button1_Click(object sender, EventArgs e)
  {

    Label2.Text =
      @"<h3>Calendar GenericWebPart Properties</h3>" +
      "<em>Title: </em>" + calendarPart.Title +
      "<br />" +
      "<em>CatalogIconImageUrl:  </em>" + calendarPart.CatalogIconImageUrl +
      "<br />" +
      "<em>TitleUrl: </em>" + calendarPart.TitleUrl +
      "<br />" +
      "<em>Decription: </em>" + calendarPart.Description +
      "<br />" +
      "<em>TitleIconImageUrl: </em>" + calendarPart.TitleIconImageUrl +
      "<br />" +
      "<em>ChildControl ID: </em>" + calendarPart.ChildControl.ID +
      "<br />" +
      "<em>ChildControl Type: </em>" + calendarPart.ChildControl.GetType().Name +
      "<br />" +
      "<em>GenericWebPart ID: </em>" + calendarPart.ID +
      "<br />" +
      "<em>GenericWebPart Type: </em>" + calendarPart.GetType().Name +
      "<br />" +
      "<em>GenericWebPart Parent ID: </em>" + calendarPart.Parent.ID;

    Label3.Text =
      @"<h3>BulletedList GenericWebPart Properties</h3>" +
      "<em>Title: </em>" + listPart.Title +
      "<br />" +
      "<em>CatalogIconImageUrl:  </em>" + listPart.CatalogIconImageUrl +
      "<br />" +
      "<em>TitleUrl: </em>" + listPart.TitleUrl +
      "<br />" +
      "<em>Decription: </em>" + listPart.Description +
      "<br />" +
      "<em>TitleIconImageUrl: </em>" + listPart.TitleIconImageUrl +
      "<br />" +
      "<em>ChildControl ID: </em>" + listPart.ChildControl.ID +
      "<br />" +
      "<em>ChildControl Type: </em>" + listPart.ChildControl.GetType().Name +
      "<br />" +
      "<em>GenericWebPart ID: </em>" + listPart.ID +
      "<br />" +
      "<em>GenericWebPart Type: </em>" + listPart.GetType().Name +
      "<br />" +
      "<em>GenericWebPart Parent ID: </em>" + listPart.Parent.ID;
  }
}

Imports System.Data
Imports System.Configuration
Imports System.Web
Imports System.Web.Security
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts
Imports System.Web.UI.HtmlControls

Partial Public Class genericwebpart_sample

  Inherits System.Web.UI.Page

  Private calendarPart As GenericWebPart
  Private listPart As GenericWebPart

  Protected Sub Page_Load(ByVal sender As [Object], ByVal e As EventArgs)
    calendarPart = WebPartManager1.GetGenericWebPart(Calendar1)
    listPart = WebPartManager1.GetGenericWebPart(BulletedList1)

    If Not IsPostBack Then
      Label2.Text = String.Empty
      Label3.Text = String.Empty
    End If

  End Sub


  Protected Sub Button1_Click(ByVal sender As Object, ByVal e As EventArgs)

    Label2.Text = _
      "<h3>Calendar GenericWebPart Properties</h3>" & _
      "<em>Title: </em>" & calendarPart.Title & _
      "<br />" & _
      "<em>CatalogIconImageUrl:  </em>" & calendarPart.CatalogIconImageUrl & _
      "<br />" & _
      "<em>TitleUrl: </em>" & calendarPart.TitleUrl & _
      "<br />" & _
      "<em>Decription: </em>" & calendarPart.Description & _
      "<br />" & _
      "<em>TitleIconImageUrl: </em>" & calendarPart.TitleIconImageUrl & _
      "<br />" & _
      "<em>ChildControl ID: </em>" & calendarPart.ChildControl.ID & _
      "<br />" & _
      "<em>ChildControl Type: </em>" & calendarPart.ChildControl.GetType().Name & _
      "<br />" & _
      "<em>GenericWebPart ID: </em>" & calendarPart.ID & _
      "<br />" & _
      "<em>GenericWebPart Type: </em>" & calendarPart.GetType().Name & _
      "<br />" & _
      "<em>GenericWebPart Parent ID: </em>" & calendarPart.Parent.ID

    Label3.Text = _
      "<h3>BulletedList GenericWebPart Properties</h3>" & _
      "<em>Title: </em>" & listPart.Title & _
      "<br />" & _
      "<em>CatalogIconImageUrl:  </em>" & listPart.CatalogIconImageUrl & _
      "<br />" & _
      "<em>TitleUrl: </em>" & listPart.TitleUrl & _
      "<br />" & _
      "<em>Decription: </em>" & listPart.Description & _
      "<br />" & _
      "<em>TitleIconImageUrl: </em>" & listPart.TitleIconImageUrl & _
      "<br />" & _
      "<em>ChildControl ID: </em>" & listPart.ChildControl.ID & _
      "<br />" & _
      "<em>ChildControl Type: </em>" & listPart.ChildControl.GetType().Name & _
      "<br />" & _
      "<em>GenericWebPart ID: </em>" & listPart.ID & _
      "<br />" & _
      "<em>GenericWebPart Type: </em>" & listPart.GetType().Name & _
      "<br />" & _
      "<em>GenericWebPart Parent ID: </em>" & listPart.Parent.ID
  End Sub

End Class

Remarks

The GenericWebPart control exists to provide a run-time wrapper for server controls that are not WebPart controls, so that such controls can be used in Web Parts pages and applications. When developers add server controls--such as user controls, ASP.NET server controls, or existing custom controls--to a WebPartZoneBase control, the GenericWebPart control automatically wraps the server controls at run time so they can exhibit the same functionality as true WebPart controls.

The following table compares and contrasts GenericWebPart controls and WebPart controls.

GenericWebPart control	WebPart control
Exists to equip server controls that are not WebPart controls with Web Parts functionality, so that any ASP.NET, custom, or user control can participate in Web Parts applications.	Exists to create custom ASP.NET controls that have native Web Parts functionality built in. This includes personalization, connections, import and export, and drag-and-drop capabilities.
Is never declared in the markup of a page. It exists only to wrap server controls at run time, and to give the wrapped control (or child control) the full functionality of a WebPart control.	Can be declared in the markup of a page at design time, like an ASP.NET server control, except that it is declared in a WebPartZoneBase zone.
Includes and integrates its child control into the Web Parts personalization process so that it can act as a true WebPart control. This occurs automatically, which makes it simple for developers to use server controls and user controls in Web Parts applications.	Is automatically included in the Web Parts personalization process.
Can be accessed programmatically at run time (by using the GetGenericWebPart method and passing to it the child server control), like a true WebPart control or a standard ASP.NET control.	Can be accessed programmatically at run time, like a standard ASP.NET control.

Users benefit from the GenericWebPart control because it provides a consistent user experience. Any server control can be made to function like a WebPart control, and will have the same consistent user interface (UI) elements such as verbs, icons, a title, and a header. Developers benefit from the GenericWebPart control because it enables them to reuse existing user controls and server controls within Web Parts applications.

Note

When you create Web Parts pages, you do not have to do anything to enable an existing user control or custom control to be wrapped with the GenericWebPart control. Simply add your server or user control to a WebPartZoneBase zone, either programmatically or by declaring it in the page's markup, and the Web Parts control set automatically wraps your control with a GenericWebPart object at run time.

Because server controls that are placed in WebPartZoneBase zones are wrapped with a GenericWebPart control at run time, developers can use ordinary server and user controls exactly as if they were WebPart controls. Note that, if you declare custom controls that inherit from the base Control class within a WebPartZone, these controls cannot support the use of the intrinsic WebPart properties. Thus, you cannot declare the IWebPart properties on such controls, including properties such as the Title property and the Description property. In contrast, other types of server controls (such as WebPart controls, user controls, and custom controls that inherit from WebControl) can declare these properties, because they support the use of expando properties.

Expando properties are actually strings that can be added to a class dynamically as a property, by means of the IAttributeAccessor interface. Controls that implement this interface, including the WebControl class and its children, can use expando properties. Because the base Control class does not support expando properties, when a custom control that inherits from the Control class is placed in a WebPartZone and wrapped with a GenericWebPart control at run time, the Web Parts control set cannot dynamically add the intrinsic IWebPart properties to the custom control. You have two choices in this case. You can use the custom control without the IWebPart properties, or you can implement the IWebPart interface in the custom control, enabling it to use the properties.

As an example of how controls that inherit from WebControl can use the IWebPart properties, if you declare an ASP.NET Calendar control in the markup of a page (within a WebPartZoneBase zone) at design time, even though this control does not inherit from the WebPart class and does not natively contain WebPart members, you can still treat it exactly like a WebPart control. You can declare WebPart properties on the calendar control, such as Title, Description, and others. At run time, you can use the GetGenericWebPart method, which returns the GenericWebPart control that is dynamically wrapping the calendar control, and work with it programmatically exactly as you would with a WebPart control, with access to all the same properties, events, and methods.

The GenericWebPart control has a critical property that allows you to access its underlying server control: the ChildControl property. This property allows developers to programmatically access the server control. The ChildControl property is also used by the WebPartManager control to access personalization data from the child control, and to perform authorization, if the AuthorizationFilter property is set.

The GenericWebPart control has several other properties, all of which override properties inherited from the base WebPart class. As noted, you can use these properties with any child control, so that it can behave as a WebPart control. One important property is the ExportMode property; it determines whether all the exportable properties, or only those marked as non-sensitive, can be exported. The UI-oriented properties inherited from the WebPart class, such as CatalogIconImageUrl, Description, Height, Title, TitleUrl, and Width, can be set in the declarative markup for any server control that is placed in a WebPartZoneBase zone.

Important methods in the GenericWebPart class include the CreateControlCollection method, which creates the collection of controls (including child controls) associated with a GenericWebPart control, and the Render method, which delegates all rendering to the wrapped child controls. The constructors on the GenericWebPart class are protected and are intended either for internal use or for extensibility scenarios.

There are some additional helpful insights for working with GenericWebPart controls. If you want to set default values for the overridden properties in the GenericWebPart class, your user control or custom server control can implement the IWebPart and IWebActionable interfaces, and override their members. At run time, the GenericWebPart control will get its values for the implemented properties from the child control that implements the interfaces. If your control defines any of its properties as personalizable (by using the Personalizable metadata attribute), the GenericWebPart control automatically enables those properties for personalization at run time, just like the personalizable properties on a WebPart control.

If you want to provide Web Parts editing features for your control, you can implement the IWebEditable interface. At run time, when the CreateEditorParts method is called, the GenericWebPart control's code for the WebBrowsableObject property will call into the same property in the child control, and use the child control's implementation to create associated custom EditorPart controls.

Notes to Inheritors

There are few occasions where it is necessary to inherit from the GenericWebPart class. One such case would be if a developer wants to implement some custom action in the constructor when a GenericWebPart control is created. For example, you might want to store the child control somewhere other than the control collection within the GenericWebPart class. If you inherit from the GenericWebPart class, you also need to inherit from the WebPartManager class and override its CreateWebPart(Control) method to enable it to create your custom control.

Constructors

GenericWebPart(Control)

Initializes a new instance of a GenericWebPart control by passing in a reference to a control that becomes the child control.

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)
AllowClose	Gets or sets a value indicating whether an end user can close a WebPart control on a Web page. (Inherited from WebPart)
AllowConnect	Gets or sets a value that indicates whether the WebPart control allows other controls to form connections with it. (Inherited from WebPart)
AllowEdit	Gets or sets a value indicating whether an end user can modify a WebPart control through the user interface (UI) provided by one or more EditorPart controls. (Inherited from WebPart)
AllowHide	Gets or sets a value indicating whether end users are allowed to hide a WebPart control. (Inherited from WebPart)
AllowMinimize	Gets or sets a value indicating whether end users can minimize a WebPart control. (Inherited from WebPart)
AllowZoneChange	Gets or sets a value indicating whether a user can move a WebPart control between WebPartZoneBase zones. (Inherited from WebPart)
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)
AuthorizationFilter	Gets or sets an arbitrary string to determine whether a WebPart control is authorized to be added to a page. (Inherited from WebPart)
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)
CatalogIconImageUrl	Gets or sets the URL to an image that represents a GenericWebPart control in a catalog of controls.
ChildControl	Gets a reference to the child control that is wrapped by a GenericWebPart control at run time.
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 WebPart)
ChromeType	Gets or sets the type of border that frames a Web Parts control. (Inherited from WebPart)
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)
ConnectErrorMessage	Gets an error message to display to users if errors occur during the connection process. (Inherited from WebPart)
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 a control does, for use in ToolTips and catalogs of server controls.
DesignMode	Gets a value indicating whether a control is being used on a design surface. (Inherited from Control)
Direction	Gets or sets the horizontal direction that content flows within the control. (Inherited from WebPart)
DisplayTitle	Gets a string that contains the full title text actually displayed in the title bar of a WebPart control instance. (Inherited from WebPart)
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)
ExportMode	Gets or sets whether all, some, or none of a WebPart control's properties can be exported. (Inherited from WebPart)
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)
HasSharedData	Gets a value that indicates whether a WebPart control has any shared personalization data associated with it. (Inherited from WebPart)
HasUserData	Gets a value that indicates whether a WebPart control has any user personalization data associated with it. (Inherited from WebPart)
Height	Gets or sets the height (in pixels) of a control.
HelpMode	Gets or sets the type of user interface (UI) used to display Help content for a WebPart control. (Inherited from WebPart)
HelpUrl	Gets or sets the URL to a Help file for a WebPart control. (Inherited from WebPart)
Hidden	Gets or sets a value indicating whether a WebPart control is displayed on a Web page. (Inherited from WebPart)
HorizontalAlign	Gets or sets the horizontal alignment of the contents within the panel. (Inherited from Panel)
ID	Gets or sets the ID of a control. This value is not inheritable.
IdSeparator	Gets the character used to separate control identifiers. (Inherited from Control)
ImportErrorMessage	Gets or sets an error message that is used if errors occur when a WebPart control is imported. (Inherited from WebPart)
IsChildControlStateCleared	Gets a value indicating whether controls contained within this control have control state. (Inherited from Control)
IsClosed	Gets a value that indicates whether a WebPart control is currently closed on a Web Parts page. (Inherited from WebPart)
IsEnabled	Gets a value indicating whether the control is enabled. (Inherited from WebControl)
IsShared	Gets a value that indicates whether a WebPart control is shared, meaning that it is visible to all users of a Web Parts page. (Inherited from WebPart)
IsStandalone	Gets a value that indicates whether a WebPart control is standalone, meaning that it is not contained within a WebPartZoneBase zone. (Inherited from WebPart)
IsStatic	Gets a value that indicates whether a WebPart control is a static control, which means the control is declared in the markup of a Web Parts page and not added to the page programmatically. (Inherited from WebPart)
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)
Subtitle	Gets a string that is concatenated with the Title property value to form a complete title for a control.
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 GenericWebPart control.
TitleIconImageUrl	Gets or sets the URL to an image used to represent a GenericWebPart control in the control's own title bar.
TitleUrl	Gets or sets a URL to supplemental information about a GenericWebPart control.
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)
Verbs	Gets a collection of custom verbs associated with a GenericWebPart 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)
WebBrowsableObject	Gets a reference to the child control, to enable the control to be edited by custom EditorPart controls.
WebPartManager	Gets a reference to the WebPartManager control associated with a WebPart control instance. (Inherited from WebPart)
Width	Gets or sets the width (in pixels) of the control.
Wrap	Gets or sets a value indicating whether the content wraps within the panel. (Inherited from Panel)
Zone	Gets the WebPartZoneBase zone that currently contains a WebPart control. (Inherited from WebPart)
ZoneIndex	Gets the index position of a WebPart control within its zone. (Inherited from WebPart)

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.
CreateControlCollection()	Overrides the base method to create a read-only collection that consists of the child control wrapped by a GenericWebPart control.
CreateControlStyle()	Creates a style object that is used internally by the Panel control to implement all style related properties. (Inherited from Panel)
CreateEditorParts()	Returns a collection of custom EditorPart controls that can be used to edit the child control of a GenericWebPart control when it is in edit mode.
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)	Searches the current naming container for a server control with the specified `id` parameter. (Inherited from Control)
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)
Focus()	Sets input focus to a control. (Inherited from Control)
GetDesignModeState()	Gets design-time data for a control. (Inherited from Control)
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)
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)
OnClosing(EventArgs)	Enables derived classes to provide custom handling when a WebPart control is closed on a Web Parts page. (Inherited from WebPart)
OnConnectModeChanged(EventArgs)	Enables derived classes to provide custom handling when a WebPart control is beginning or ending the process of connecting to other controls. (Inherited from WebPart)
OnDataBinding(EventArgs)	Raises the DataBinding event. (Inherited from Control)
OnDeleting(EventArgs)	Enables derived classes to provide custom handling when a WebPart control is permanently removed from a Web Parts page. (Inherited from WebPart)
OnEditModeChanged(EventArgs)	Enables derived classes to provide custom handling when a WebPart control is entering or leaving edit mode. (Inherited from WebPart)
OnInit(EventArgs)	Raises the Init event. (Inherited from Control)
OnLoad(EventArgs)	Raises the Load event. (Inherited from Control)
OnPreRender(EventArgs)	Raises the PreRender event. (Inherited from Control)
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)	Delegates rendering the contents of the control to the child control.
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)	Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control)
RenderControl(HtmlTextWriter, ControlAdapter)	Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (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. (Inherited from Control)
SetPersonalizationDirty()	Sets a flag indicating that personalization data has changed for the current WebPart control instance. (Inherited from WebPart)
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)	Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. (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)
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 WebPart)

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)	Sets 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.
TryGetMetaTable(INamingContainer, MetaTable)	Determines whether table metadata is available.
EnableDynamicData(INamingContainer, Type)	Enables Dynamic Data behavior for the specified data control.
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.

Applies to