WebZone Class
Definition
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 all controls that act as containers for server controls (including Web Parts Part controls, server controls, and user controls) in Web Parts applications.
public ref class WebZone abstract : System::Web::UI::WebControls::CompositeControl[System.ComponentModel.Bindable(false)]
public abstract class WebZone : System.Web.UI.WebControls.CompositeControl[<System.ComponentModel.Bindable(false)>]
type WebZone = class
inherit CompositeControlPublic MustInherit Class WebZone
Inherits CompositeControl- Inheritance
- Derived
- Attributes
Examples
The following code example demonstrates the use of the WebZone class.
The first part of the code example shows two custom controls that derive from the WebPart class. For the code example to run, you must compile this source code. You can compile it explicitly and put the resulting assembly in your Web site's Bin folder or the global assembly cache. Alternatively, you can put the source code in your site's App_Code folder, where it will be dynamically compiled at run time. For a walkthrough that demonstrates both methods of compiling, see Walkthrough: Developing and Using a Custom Web Server Control.
using System;
using System.Security.Permissions;
using System.Web;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
namespace Samples.AspNet.CS.Controls
{
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public class CalendarWebPart : WebPart
{
Calendar _calendar;
public CalendarWebPart()
{
this.AllowClose = false;
}
protected override void CreateChildControls()
{
Controls.Clear();
_calendar = new Calendar();
_calendar.Caption = "My Calendar";
this.Controls.Add(_calendar);
ChildControlsCreated = true;
}
}
[AspNetHostingPermission(SecurityAction.Demand,
Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermission(SecurityAction.InheritanceDemand,
Level = AspNetHostingPermissionLevel.Minimal)]
public class LinksWebPart : WebPart
{
Literal _literal;
const string _literalText = @"
<table>
<tr>
<td><a href='http://msdn.microsoft.com'>MSDN</a></td>
</tr>
<tr>
<td><a href='http://msn.microsoft.com'>MSN</a></td>
</tr>
<tr>
<td><a href='http://www.msnbc.msn.com'>MSNBC</a></td>
</tr>
</table>";
public LinksWebPart()
{
this.AllowClose = false;
}
protected override void CreateChildControls()
{
Controls.Clear();
_literal = new Literal();
_literal.Text = _literalText;
this.Controls.Add(_literal);
ChildControlsCreated = true;
}
}
}
Imports System.Security.Permissions
Imports System.Web
Imports System.Web.UI.WebControls
Imports System.Web.UI.WebControls.WebParts
Namespace Samples.AspNet.VB.Controls
<AspNetHostingPermission(SecurityAction.Demand, _
Level := AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level := AspNetHostingPermissionLevel.Minimal)> _
Public Class CalendarWebPart
Inherits WebPart
Private _calendar As Calendar
Public Sub New()
Me.AllowClose = False
End Sub
Protected Overrides Sub CreateChildControls()
Controls.Clear()
_calendar = New Calendar()
_calendar.Caption = "My Calendar"
Me.Controls.Add(_calendar)
ChildControlsCreated = True
End Sub
End Class
<AspNetHostingPermission(SecurityAction.Demand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
Level:=AspNetHostingPermissionLevel.Minimal)> _
Public Class LinksWebPart
Inherits WebPart
Private _literal As Literal
Private Const _literalText As String = _
"<table>" & _
"<tr>" & _
"<td><a href='http://msdn.microsoft.com'>MSDN</a></td>" & _
"</tr>" & _
"<tr>" & _
"<td><a href='http://msn.microsoft.com'>MSN</a></td>" & _
"</tr>" & _
"<tr>" & _
"<td><a href='http://www.msnbc.msn.com'>MSNBC</a></td>" & _
"</tr>" & _
"</table>"
Public Sub New()
Me.AllowClose = False
End Sub
Protected Overrides Sub CreateChildControls()
Controls.Clear()
_literal = New Literal()
_literal.Text = _literalText
Me.Controls.Add(_literal)
ChildControlsCreated = True
End Sub
End Class
End Namespace
The second part of the code example shows a Web page that hosts the WebPart controls. Notice that the declarative markup contains two WebPartZone controls, a CatalogZone control and an EditorZone control.
<%@ page language="C#" %>
<%@ register TagPrefix="uc1"
TagName="DisplayModeMenuCS"
Src="DisplayModeMenuCS.ascx" %>
<%@ register tagprefix="aspSample"
Namespace="Samples.AspNet.CS.Controls"
Assembly="ZoneWebPartsCS"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
<title>ASP.NET Example</title>
</head>
<body>
<form id="Form1" runat="server">
<asp:webpartmanager id="WebPartManager1" runat="server" />
<uc1:DisplayModeMenuCS ID="DisplayModeMenu1" runat="server" />
<asp:webpartzone
id="WebPartZone1"
runat="server"
title="Zone 1"
PartChromeType="TitleAndBorder">
<parttitlestyle font-bold="true" ForeColor="#3300cc"/>
<partstyle
borderwidth="1px"
borderstyle="Solid"
bordercolor="#81AAF2" />
<ZoneTemplate>
<aspSample:CalendarWebPart
runat="server"
id="CalendarWebPart1"
Title="Calendar WebPart"
/>
</ZoneTemplate>
</asp:webpartzone>
<asp:webpartzone
id="WebPartZone2"
runat="server"
title="Zone 2"
PartChromeType="TitleAndBorder"
EmptyZoneText="Empty Zone">
<parttitlestyle font-bold="true" ForeColor="#3300cc"/>
<partstyle
borderwidth="1px"
borderstyle="Solid"
bordercolor="#81AAF2" />
</asp:webpartzone>
<asp:EditorZone ID="editzone1" Runat="server">
<ZoneTemplate>
<asp:AppearanceEditorPart
ID="appearanceeditor1"
Runat="server" />
<asp:LayoutEditorPart
ID="LayoutEditorPart1"
Runat="server" />
</ZoneTemplate>
</asp:EditorZone>
<asp:CatalogZone ID="catalogzone1" Runat="server" >
<ZoneTemplate>
<asp:DeclarativeCatalogPart
ID="declarativepart1"
Runat="server">
<WebPartsTemplate>
<aspSample:LinksWebPart
runat="server"
id="linkswebpart"
Title="Favorite Links"
/>
</WebPartsTemplate>
</asp:DeclarativeCatalogPart>
</ZoneTemplate>
</asp:CatalogZone>
<br />
</form>
</body>
</html>
<%@ page language="VB" %>
<%@ register TagPrefix="uc1"
TagName="DisplayModeMenuVB"
Src="DisplayModeMenuVB.ascx" %>
<%@ register tagprefix="aspSample"
Namespace="Samples.AspNet.VB.Controls"
Assembly="ZoneWebPartsVB"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
<title>ASP.NET Example</title>
</head>
<body>
<form id="Form1" runat="server">
<asp:webpartmanager id="WebPartManager1" runat="server" />
<uc1:DisplayModeMenuVB ID="DisplayModeMenu1" runat="server" />
<asp:webpartzone
id="WebPartZone1"
runat="server"
title="Zone 1"
PartChromeType="TitleAndBorder">
<parttitlestyle font-bold="true" ForeColor="#3300cc"/>
<partstyle
borderwidth="1px"
borderstyle="Solid"
bordercolor="#81AAF2" />
<ZoneTemplate>
<aspSample:CalendarWebPart
runat="server"
id="CalendarWebPart1"
Title="Calendar WebPart"
/>
</ZoneTemplate>
</asp:webpartzone>
<asp:webpartzone
id="WebPartZone2"
runat="server"
title="Zone 2"
PartChromeType="TitleAndBorder"
EmptyZoneText="Empty Zone">
<parttitlestyle font-bold="true" ForeColor="#3300cc"/>
<partstyle
borderwidth="1px"
borderstyle="Solid"
bordercolor="#81AAF2" />
</asp:webpartzone>
<asp:EditorZone ID="editzone1" Runat="server">
<ZoneTemplate>
<asp:AppearanceEditorPart
ID="appearanceeditor1"
Runat="server" />
<asp:LayoutEditorPart
ID="LayoutEditorPart1"
Runat="server" />
</ZoneTemplate>
</asp:EditorZone>
<asp:CatalogZone ID="catalogzone1" Runat="server" >
<ZoneTemplate>
<asp:DeclarativeCatalogPart
ID="declarativepart1"
Runat="server">
<WebPartsTemplate>
<aspSample:LinksWebPart
runat="server"
id="linkswebpart"
Title="Favorite Links"
/>
</WebPartsTemplate>
</asp:DeclarativeCatalogPart>
</ZoneTemplate>
</asp:CatalogZone>
<br />
</form>
</body>
</html>
You can load the page in a browser and switch among the various page display modes to see how the different zones behave. For more information on display modes and enabling users to switch among them, see Walkthrough: Changing Display Modes on a Web Parts Page.
Remarks
A Web Parts zone is a defined region that contains server controls on a Web page, and provides a consistent user interface (UI), layout, and rendering for the contained controls. Zones are rendered in a browser as HTML tables.
The WebZone class is the base class for all Web Parts zones. A zone control is a composite control designed to contain other controls, hence the WebZone class inherits from the CompositeControl class. Together with the WebPartManager control and Part controls (or other user or server controls that can be placed in zones), zone controls derived from the WebZone base class form the essential building blocks of a Web Parts application.
A critical role of Web Parts zones is to enable full Web Parts functionality for the controls they contain. Every Web Parts page contains at least one zone, and a zone can contain zero or more part controls. Zones are required for Web Parts functionality. Without zones, even controls that derive from the WebPart class can have very little Web Parts functionality. Conversely, because of the design of the Web Parts control set, you can place ordinary ASP.NET controls, server controls, or user controls into a WebPartZoneBase zone (which derives from WebZone), and by virtue of being in the zone, these ordinary server controls are enable to act as WebPart controls at run time. For details, see the documentation for the GenericWebPart class.
Note
It is possible to add Part or WebPart controls to a page outside of a zone, but in that case they simply function as ordinary server controls.
There are two broad categories of zones in the Web Parts control set, all of which inherit from the base WebZone class.
WebPartZoneBase zones. These contain WebPart (and other server and user) controls, and form the primary UI of Web Parts pages that users interact with most of the time.
ToolZone zones. These zones provide special views of a Web Parts page that enable users to modify (personalize) the content, layout, appearance, behavior, and properties of controls contained in WebPartZoneBase zones on a Web Parts page. For example, a CatalogZoneBase zone is a ToolZone that provides a catalog view of a page, enabling users to add and remove server controls. An EditorZoneBase zone is another type of ToolZone that provides an editing view of a page, enabling users to modify and edit the layout of the page, along with the properties, appearance, and behavior of the controls.
Each zone in the Web Parts control set is designed to contain a corresponding type of control derived from the Part class, with the part controls serving as the main content and primary UI of the zone. Zone types in the Web Parts control set, along with the corresponding types of part controls they contain, are shown in the following table.
| Part control type | Zone type |
|---|---|
| WebPart (and server and user controls, which are wrapped with a GenericWebPart at run time) | WebPartZone (the base class is WebPartZoneBase ) |
| EditorPart (several derived controls are provided with the Web Parts control set, and custom EditorPart controls can be developed) | EditorZone (the base class is EditorZoneBase ) |
| CatalogPart (several derived controls are provided with the Web Parts control set, and custom CatalogPart controls can be developed) | CatalogZone (the base class is CatalogZoneBase ) |
| WebPartConnection (connection controls are unique in that they are not part controls that inherit from the base class) | ConnectionsZone (inherits directly from ToolZone ) |
All zones in the Web Parts control have basic, common user interface elements that they inherit from the base WebZone class. Not all these elements are visible on every zone, but each zone type is capable of having these common, zone-related UI elements, as described in the following table.
| Zone section | Description |
|---|---|
| Header | The top section of a zone. It includes header text, which can include a title for the zone; style attributes (such as a border or background color) that distinguish the header; and zone-level verbs (represented by buttons, hyperlinks, or images) that users can click to perform UI actions that apply to the entire zone, such as closing a zone. Several WebZone properties, such as HasHeader, HeaderStyle, and HeaderText, relate to the header area of a zone. If there are zone-level verbs in the zone, the VerbButtonType and VerbStyle properties apply to them. Note that these two verb properties apply to zone-level verbs only, not to verbs in the individual part controls contained in the zone. Headers are not present in every type of zone; typically they appear in ToolZone zones where there is a need to have a common header area with text and a verb, such as a close verb. |
| Body | The main contents section of a zone. Every zone that derives from WebZone has a body section. For all types of zones in the Web Parts control set, the body of the zone contains the designated type of Part controls (or other server controls) that correspond to a zone type, as indicated in the previous table. Various members of the WebZone class affect the contents of the body section, such as the BackImageUrl, PartChromeStyle, PartChromeType, and PartStyle properties. If the body section is empty, the EmptyZoneText message can be displayed in certain situations. |
| Chrome | The common UI elements rendered for each part control in a zone. This is distinct from a discussion of style attributes that apply to the zone itself; chrome applies specifically to the contained part controls. Chrome includes verbs, borders, and other style attributes such as background color, or font style of the title text, for a zone's part controls. A zone determines the chrome details by using a single chrome object appropriate to the type of part controls it contains (for example, a CatalogPartChrome object for a CatalogZone that contains CatalogPart controls). This single chrome object handles the chrome details and the rendering for all the part controls in the zone. This enables developers to create zones in which they can specify a consistent, common look and feel for all the part controls. Some properties that relate to the chrome for a zone's part controls include the PartChromeStyle, PartChromeType, PartStyle, and PartTitleStyle properties. Note that most chrome-related properties, including a specific property to reference the chrome object for a particular type of zone, are not implemented in the base WebZone class. Instead, most chrome-specific features of zones are implemented on specific zone types as appropriate to the unique needs of their part controls. See the topics for each zone type listed in the previous table of this topic. |
| Part Controls | The controls that reside in the body section of a zone. Every zone that inherits from the WebZone class contains in its body section one or more part controls of a corresponding type, as shown in the previous table in this topic. These part controls form the main UI of Web Parts applications. Most zone types that derive from WebZone have a collection property that enables them to reference all their contained part controls, such as the WebParts property on the WebPartZoneBase class, and the EditorParts property on the EditorZoneBase class. |
| Footer | The bottom section of a zone. Like the header section, it is not present in every type of zone, but usually occurs in ToolZone zones. Typical contents of a footer section are verbs such as an ok verb or an apply verb, which appear in the footer of EditorZoneBase zones. Some properties that relate to the footer section include the HasFooter, FooterStyle, VerbButtonType, and VerbStyle properties. |
Most of the WebZone class's properties are discussed in the preceding table that describes the common UI elements of zones. The WebZone class also has several methods relating to its role of rendering content. The RenderBody, RenderContents, RenderFooter, and RenderHeader methods can all be overridden to provide programmatic control over the rendering of each specific section of a zone. For example, if you want to customize the rendering of all the footer sections of catalog zones in your application, you could inherit from the CatalogZoneBase class, override the RenderFooter method inherited from WebZone, and change the rendering of the footer section.
Notes to Implementers
You rarely need to inherit directly from the WebZone class to develop custom Web Parts zones. The Web Parts control set contains the specialized zones listed above in the Remarks section, and usually you can derive from one of them to add custom behavior to a zone. If you do decide to inherit directly from the WebZone class, you must override a number of properties and methods (see the documentation for the members of the WebZone class). You must also create a custom WebPartManager control, optionally a custom WebPartDisplayMode control to create a unique display mode in which to view your zone, and other customizations to make your zone work within the Web Parts control set.
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 to a background image for a zone. |
| 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) |
| 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 represents the child controls in a CompositeControl. (Inherited from CompositeControl) |
| 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) |
| DesignMode |
Gets a value indicating whether a control is being used on a design surface. (Inherited from Control) |
| EmptyZoneText |
Gets or sets a message that appears when a zone contains no controls. |
| EmptyZoneTextStyle |
Gets the style attributes for the placeholder text in an empty zone. |
| 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) |
| ErrorStyle |
Gets the style attributes for rendering the error message that is displayed if a WebPart control cannot be loaded or created. |
| 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) |
| FooterStyle |
Gets the style attributes for the contents of a zone's footer area. |
| ForeColor |
Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl) |
| 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) |
| HasFooter |
Gets a value indicating whether a zone has a footer area. |
| HasHeader |
Gets a value indicating whether a zone has a header area. |
| HeaderStyle |
Gets the style attributes for the contents of a zone's header area. |
| HeaderText |
Gets or sets the text for the header area of a zone. |
| Height |
Gets or sets the height of the Web server control. (Inherited from WebControl) |
| 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) |
| Padding |
Gets or sets the cell padding attributes on the table that contains the WebPart controls in a zone. |
| 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) |
| PartChromePadding |
Gets or sets the distance between the contents of a WebPart control and the border of the control. |
| PartChromeStyle |
Gets style characteristics that apply to the borders of Web Parts controls contained by a zone. |
| PartChromeType |
Gets or sets the type of border that frames Web Parts controls contained by a zone. |
| PartStyle |
Gets style characteristics that apply to the border and contents of each Web Parts control contained by a zone. |
| PartTitleStyle |
Gets style attributes for the title bar content for each Web Parts control contained by a zone. |
| RenderClientScript |
Gets a value that indicates whether to render client script on a Web Parts page. |
| RenderingCompatibility |
Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control) |
| 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 |
| 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. |
| 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) |
| 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) |
| VerbButtonType |
Gets or sets what kind of button is used to represent verbs in a zone. |
| VerbStyle |
Gets the style attributes for the user interface (UI) verbs associated with Web Parts controls in a zone. |
| 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 WebPartManager control associated with a WebZone control instance on a Web Parts page. |
| Width |
Gets or sets the width of the Web server control. (Inherited from WebControl) |
Methods
| AddAttributesToRender(HtmlTextWriter) |
Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers. (Inherited from WebControl) |
| 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 |
| 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 the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers. (Inherited from WebControl) |
| DataBind() |
Binds a data source to the CompositeControl and all its child controls. (Inherited from CompositeControl) |
| 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 |
| FindControl(String) |
Searches the current naming container for a server control with the specified |
| Focus() |
Sets input focus to a control. (Inherited from Control) |
| GetDesignModeState() |
Gets design-time data for a control. (Inherited from Control) |
| GetEffectiveChromeType(Part) |
Returns the actual or effective current PartChromeType value of a WebPart control, given the PartChromeType property of the zone and the current display mode of the Web Parts page. |
| 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) |
Loads previously saved state information for a zone. |
| 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. |
| 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) |
| RecreateChildControls() |
Recreates the child controls in a control derived from CompositeControl. (Inherited from CompositeControl) |
| RemovedControl(Control) |
Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control) |
| Render(HtmlTextWriter) |
Writes the CompositeControl content to the specified HtmlTextWriter object, for display on the client. (Inherited from CompositeControl) |
| RenderBeginTag(HtmlTextWriter) |
Renders the opening HTML tag of the zone control to the specified HtmlTextWriter object. |
| RenderBody(HtmlTextWriter) |
Overrides rendering for the body of a zone control. |
| 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 entire contents of a zone control between the beginning and ending tags to the specified HtmlTextWriter object. |
| 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 control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl) |
| RenderFooter(HtmlTextWriter) |
Overrides rendering for the footer of a zone control. |
| RenderHeader(HtmlTextWriter) |
Overrides rendering for the header of a zone control. |
| 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 view-state changes that have occurred after a page was posted back to the server. |
| SetDesignModeState(IDictionary) |
Sets design-time data for a control. (Inherited from 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() |
Tracks changes to a zone control's view state. |
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() |
Enables a designer to recreate the composite control's collection of child controls in the design-time environment. (Inherited from CompositeControl) |
| 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. |
