This topic has not yet been rated - Rate this topic

WebPartZoneBase Class

Serves as the base class for all zone controls that act as containers for WebPart (or other server or user) controls.

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.CompositeControl
        System.Web.UI.WebControls.WebParts.WebZone
          System.Web.UI.WebControls.WebParts.WebPartZoneBase
            System.Web.UI.WebControls.WebParts.WebPartZone

Namespace:  System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)
public abstract class WebPartZoneBase : WebZone, 
	IPostBackEventHandler
<asp:WebPartZoneBase />

The WebPartZoneBase type exposes the following members.

  Name Description
Protected method WebPartZoneBase Initializes the class for use by an inherited class instance. This constructor can only be called by an inherited class.
Top
  Name Description
Public property AccessKey Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.)
Protected property Adapter Gets the browser-specific adapter for the control. (Inherited from Control.)
Public property AllowLayoutChange Gets or sets a value that indicates whether the layout of WebPart controls can be changed within a zone.
Public property AppRelativeTemplateSourceDirectory Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.)
Public property Attributes Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.)
Public property BackColor Gets or sets the background color of the Web server control. (Inherited from WebControl.)
Public property BackImageUrl Gets or sets the URL to a background image for a zone. (Inherited from WebZone.)
Public property BindingContainer Infrastructure. Gets the control that contains this control's data binding. (Inherited from Control.)
Public property BorderColor Gets or sets the color for the border of a WebPartZoneBase control. (Overrides WebControl.BorderColor.)
Public property BorderStyle Gets or sets the kind of border that surrounds a WebPartZoneBase control. (Overrides WebControl.BorderStyle.)
Public property BorderWidth Gets or sets the width of the border that surrounds a WebPartZoneBase control. (Overrides WebControl.BorderWidth.)
Protected property ChildControlsCreated Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.)
Public property ClientID Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.)
Public property ClientIDMode Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.)
Protected property ClientIDSeparator Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.)
Public property CloseVerb Gets a reference to a WebPartVerb object that enables end users to close the WebPart controls in a zone.
Public property ConnectVerb Gets a reference to a WebPartVerb object that enables end users to create connections between WebPart controls.
Protected property Context Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.)
Public property Controls Gets a ControlCollection object that represents the child controls in a CompositeControl. (Inherited from CompositeControl.)
Public property ControlStyle Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
Public property 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.)
Public property CssClass Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.)
Public property DataItemContainer Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.)
Public property DataKeysContainer Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.)
Public property DeleteVerb Gets a reference to a WebPartVerb object that enables end users to delete the WebPart controls in a zone.
Protected property DesignMode Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.)
Public property DisplayTitle Gets the current value of the text being used as the title for a WebPartZoneBase zone when the zone itself is visible.
Protected property DragDropEnabled Gets a value that indicates whether WebPart controls can be dragged into or out of a zone.
Public property DragHighlightColor Gets or sets the color around the border of a WebPartZoneBase zone and its drop-cue regions when a user is dragging a control.
Public property EditVerb Gets a reference to a WebPartVerb object that enables end users to edit WebPart controls in a zone.
Public property EmptyZoneText Gets or sets a message that appears when a WebPartZoneBase control contains no WebPart controls. (Overrides WebZone.EmptyZoneText.)
Public property EmptyZoneTextStyle Gets the style attributes for the placeholder text in an empty zone. (Inherited from WebZone.)
Public property Enabled Gets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.)
Public property EnableTheming Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.)
Public property 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.)
Public property ErrorStyle Gets the style attributes for rendering the error message that is displayed if a WebPart control cannot be loaded or created. (Inherited from WebZone.)
Protected property Events Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.)
Public property ExportVerb Gets a reference to a WebPartVerb object that enables end users to export an XML definition file for each WebPart control in a zone.
Public property Font Gets the font properties associated with the Web server control. (Inherited from WebControl.)
Public property FooterStyle Gets the style attributes for the contents of a zone's footer area. (Inherited from WebZone.)
Public property ForeColor Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.)
Public property HasAttributes Gets a value indicating whether the control has attributes set. (Inherited from WebControl.)
Protected property HasChildViewState Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.)
Protected property HasFooter Gets a value indicating whether a zone has a footer area. (Overrides WebZone.HasFooter.)
Protected property HasHeader Gets a value indicating whether a zone has a header area. (Overrides WebZone.HasHeader.)
Public property HeaderStyle Gets the style attributes for the contents of a zone's header area. (Inherited from WebZone.)
Public property HeaderText Gets or sets the text for the header area of a zone. (Inherited from WebZone.)
Public property Height Gets or sets the height of the Web server control. (Inherited from WebControl.)
Public property HelpVerb Gets a reference to a WebPartVerb object used to access Help content for WebPart controls in a zone.
Public property ID Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
Protected property IdSeparator Infrastructure. Gets the character used to separate control identifiers. (Inherited from Control.)
Protected property IsChildControlStateCleared Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.)
Protected property IsEnabled Gets a value indicating whether the control is enabled. (Inherited from WebControl.)
Protected property IsTrackingViewState Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.)
Protected property IsViewStateEnabled Gets a value indicating whether view state is enabled for this control. (Inherited from Control.)
Public property LayoutOrientation Gets or sets a value that indicates whether controls in a zone are arranged vertically or horizontally.
Protected property LoadViewStateByID Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
Public property MenuCheckImageStyle Gets style attributes that are applied to the check mark image that appears on a verbs menu next to the selected verb text.
Public property MenuCheckImageUrl Gets or sets the URL to an image used as a check mark in the verbs menu of each WebPart control in a zone.
Public property MenuLabelHoverStyle Gets style attributes that are applied to the label of a verbs menu in the title bar of a WebPart control when a user positions the mouse pointer over the label.
Public property MenuLabelStyle Gets style information for the label of the verbs drop-down menu that appears in the title bar of each WebPart control in a zone.
Public property MenuLabelText Gets or sets the value that serves as a label for the verbs drop-down menu in the title bar of each WebPart control in a zone.
Public property MenuPopupImageUrl Gets or sets the URL to an image that opens the verbs drop-down menu in the title bar of each WebPart control in a zone.
Public property MenuPopupStyle Gets style attributes for the drop-down verbs menu that appears on WebPart controls in a zone.
Public property MenuVerbHoverStyle Gets style information for the appearance of a verb in a verbs drop-down menu when an end user positions the mouse pointer over the verb.
Public property MenuVerbStyle Gets style information for the appearance of a verb in a verbs drop-down menu when the menu is displayed.
Public property MinimizeVerb Gets a reference to a WebPartVerb object that enables end users to minimize WebPart controls in a zone.
Public property NamingContainer Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control.ID property value. (Inherited from Control.)
Public property Padding Gets or sets the cell padding attributes on the table that contains the WebPart controls in a zone. (Inherited from WebZone.)
Public property Page Gets a reference to the Page instance that contains the server control. (Inherited from Control.)
Public property Parent Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.)
Public property PartChromePadding Gets or sets the distance between the contents of a WebPart control and the border of the control. (Inherited from WebZone.)
Public property PartChromeStyle Gets style characteristics that apply to the borders of Web Parts controls contained by a zone. (Inherited from WebZone.)
Public property PartChromeType Gets or sets the type of border that frames Web Parts controls contained by a zone. (Inherited from WebZone.)
Public property PartStyle Gets style characteristics that apply to the border and contents of each Web Parts control contained by a zone. (Inherited from WebZone.)
Public property PartTitleStyle Gets style attributes for the title bar content for each Web Parts control contained by a zone. (Inherited from WebZone.)
Protected property RenderClientScript Gets a value that indicates whether to render client script on a Web Parts page. (Inherited from WebZone.)
Public property RenderingCompatibility Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.)
Public property RestoreVerb Gets a reference to a WebPartVerb object that enables end users to restore WebPart controls in a zone to normal size.
Public property SelectedPartChromeStyle Gets style information for the appearance of a selected WebPart control in a zone.
Public property ShowTitleIcons Gets or sets a value that indicates whether title icons are displayed in the title bar of each WebPart control in a zone.
Public property Site Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.)
Public property SkinID Gets or sets the skin to apply to the control. (Inherited from WebControl.)
Public property 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.)
Public property 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 CompositeControl.)
Public property TabIndex Gets or sets the tab index of the Web server control. (Inherited from WebControl.)
Protected property TagKey Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from WebZone.)
Protected property TagName Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.)
Public property TemplateControl Gets or sets a reference to the template that contains this control. (Inherited from Control.)
Public property TemplateSourceDirectory Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.)
Public property TitleBarVerbButtonType Gets or sets the type of button used for the verbs in the title bar of WebPart controls.
Public property TitleBarVerbStyle Gets style attributes for verbs in the title bar of a WebPart control.
Public property ToolTip Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.)
Public property UniqueID Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.)
Public property VerbButtonType Gets or sets the kind of button associated with the verbs that exist in a WebPartZoneBase zone when accessed with an older browser. (Overrides WebZone.VerbButtonType.)
Public property VerbStyle Gets the style attributes for the user interface (UI) verbs associated with Web Parts controls in a zone. (Inherited from WebZone.)
Protected property 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.)
Protected property ViewStateIgnoresCase Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.)
Public property ViewStateMode Gets or sets the view-state mode of this control. (Inherited from Control.)
Public property Visible Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.)
Public property WebPartChrome Gets a reference to the WebPartChrome object that determines the peripheral rendering for WebPart controls in the zone.
Protected property WebPartManager Gets a reference to the WebPartManager control associated with a WebZone control instance on a Web Parts page. (Inherited from WebZone.)
Public property WebParts Gets the collection of Web Parts controls contained within a zone.
Public property WebPartVerbRenderMode Gets or sets a value indicating how the verbs should be rendered on WebPart controls in the zone.
Public property Width Gets or sets the width of the Web server control. (Inherited from WebControl.)
Top
  Name Description
Protected method AddAttributesToRender 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.)
Protected method AddedControl Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
Protected method AddParsedSubObject 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.)
Public method ApplyStyle 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.)
Public method ApplyStyleSheetSkin Applies the style properties defined in the page style sheet to the control. (Inherited from Control.)
Protected method BuildProfileTree Infrastructure. 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.)
Protected method ClearCachedClientID Infrastructure. Sets the cached ClientID value to null. (Inherited from Control.)
Protected method ClearChildControlState Deletes the control-state information for the server control's child controls. (Inherited from Control.)
Protected method ClearChildState Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.)
Protected method ClearChildViewState Deletes the view-state information for all the server control's child controls. (Inherited from Control.)
Protected method ClearEffectiveClientIDMode Infrastructure. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.)
Protected method CloseWebPart Closes a selected WebPart control in a zone.
Protected method ConnectWebPart Initiates the process of creating a connection between two WebPart controls.
Public method CopyBaseAttributes 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.)
Protected method CreateChildControls Creates the set of child controls contained in a zone. (Overrides Control.CreateChildControls().)
Protected method CreateControlCollection Infrastructure. Creates a ControlCollection object that contains all the controls in a zone. (Overrides Control.CreateControlCollection().)
Protected method CreateControlStyle Creates a set of style characteristics that apply to a zone control when it is visible. (Overrides WebControl.CreateControlStyle().)
Protected method CreateWebPartChrome Enables derived zones to substitute a custom WebPartChrome object to change the appearance of WebPart controls in a zone.
Public method DataBind() Binds a data source to the CompositeControl and all its child controls. (Inherited from CompositeControl.)
Protected method 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.)
Protected method DataBindChildren Binds a data source to the server control's child controls. (Inherited from Control.)
Protected method DeleteWebPart Deletes a selected WebPart control in a zone.
Public method Dispose Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.)
Protected method EditWebPart Initiates the process of editing a selected WebPart control in a zone.
Protected method EnsureChildControls Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.)
Protected method EnsureID Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.)
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method FindControl(String) Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.)
Protected method FindControl(String, Int32) Infrastructure. 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.)
Public method Focus Sets input focus to a control. (Inherited from Control.)
Protected method GetDesignModeState Infrastructure. Gets design-time data for a control. (Inherited from Control.)
Public method GetEffectiveChromeType 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. (Overrides WebZone.GetEffectiveChromeType(Part).)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected method GetInitialWebParts Gets an initial collection of WebPart controls contained in a zone, based on a template or some storage medium.
Public method GetRouteUrl(Object) Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public method GetRouteUrl(RouteValueDictionary) Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public method GetRouteUrl(String, Object) Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public method GetRouteUrl(String, RouteValueDictionary) Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetUniqueIDRelativeTo Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.)
Public method HasControls Determines if the server control contains any child controls. (Inherited from Control.)
Protected method HasEvents Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.)
Protected method IsLiteralContent Infrastructure. Determines if the server control holds only literal content. (Inherited from Control.)
Protected method LoadControlState Restores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.)
Protected method LoadViewState Loads previously saved state information for a zone. (Overrides WebZone.LoadViewState(Object).)
Protected method MapPathSecure Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method MergeStyle 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.)
Protected method MinimizeWebPart Minimizes a selected WebPart control in a zone.
Protected method OnBubbleEvent Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.)
Protected method OnCreateVerbs Raises the CreateVerbs event.
Protected method OnDataBinding Raises the DataBinding event. (Inherited from Control.)
Protected method OnInit Raises the Init event. (Inherited from WebZone.)
Protected method OnLoad Raises the Load event. (Inherited from Control.)
Protected method OnPreRender Raises the PreRender event. (Overrides WebZone.OnPreRender(EventArgs).)
Protected method OnUnload Raises the Unload event. (Inherited from Control.)
Protected method OpenFile Gets a Stream used to read a file. (Inherited from Control.)
Protected method RaiseBubbleEvent Assigns any sources of the event and its information to the control's parent. (Inherited from Control.)
Protected method RaisePostBackEvent Updates the status of the current collection of WebPart controls in a zone, based on the changes that have occurred since the most recent postback event.
Protected method RecreateChildControls Recreates the child controls in a control derived from CompositeControl. (Inherited from CompositeControl.)
Protected method RemovedControl Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control.)
Protected method Render Renders the zone to the specified HtmlTextWriter object. (Overrides CompositeControl.Render(HtmlTextWriter).)
Public method RenderBeginTag Renders the opening HTML tag of the zone control to the specified HtmlTextWriter object. (Inherited from WebZone.)
Protected method RenderBody Overrides the base method to render the body area of a zone derived from the WebPartZoneBase class. (Overrides WebZone.RenderBody(HtmlTextWriter).)
Protected method RenderChildren 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.)
Protected method RenderContents Renders the entire contents of a zone control between the beginning and ending tags to the specified HtmlTextWriter object. (Inherited from WebZone.)
Public method 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.)
Protected method RenderControl(HtmlTextWriter, ControlAdapter) Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.)
Protected method RenderDropCue Renders user interface (UI) elements to indicate to an end user where a WebPart control that is being dragged can be dropped within a zone.
Public method RenderEndTag Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Protected method RenderFooter Overrides rendering for the footer of a zone control. (Inherited from WebZone.)
Protected method RenderHeader Overrides the base method to render the header of a WebPartZoneBase zone that contains WebPart controls. (Overrides WebZone.RenderHeader(HtmlTextWriter).)
Protected method ResolveAdapter Gets the control adapter responsible for rendering the specified control. (Inherited from Control.)
Public method ResolveClientUrl Gets a URL that can be used by the browser. (Inherited from Control.)
Public method ResolveUrl Converts a URL into one that is usable on the requesting client. (Inherited from Control.)
Protected method RestoreWebPart Restores a selected WebPart control that was minimized to normal state.
Protected method SaveControlState Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.)
Protected method SaveViewState Saves any view-state changes that have occurred after a page was posted back to the server. (Overrides WebZone.SaveViewState().)
Protected method SetDesignModeState Sets design-time data for a control. (Inherited from Control.)
Public method SetRenderMethodDelegate Infrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Protected method TrackViewState Begins the process of tracking view-state changes to a zone so that they can be stored in a StateBag object, and accessed through the ViewState property. (Overrides WebZone.TrackViewState().)
Top
  Name Description
Public event CreateVerbs Occurs when the verbs are created for a zone that derives from the WebPartZoneBase class.
Public event DataBinding Occurs when the server control binds to a data source. (Inherited from Control.)
Public event 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.)
Public event Init Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.)
Public event Load Occurs when the server control is loaded into the Page object. (Inherited from Control.)
Public event PreRender Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.)
Public event Unload Occurs when the server control is unloaded from memory. (Inherited from Control.)
Top
  Name Description
Public Extension Method FindDataSourceControl Returns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.)
Public Extension Method FindFieldTemplate Returns the field template for the specified column in the specified control's naming container. (Defined by DynamicDataExtensions.)
Public Extension Method FindMetaTable Returns the metatable object for the containing data control. (Defined by DynamicDataExtensions.)
Top
  Name Description
Explicit interface implemetation Private method IAttributeAccessor.GetAttribute Infrastructure. Gets an attribute of the Web control with the specified name. (Inherited from WebControl.)
Explicit interface implemetation Private method IAttributeAccessor.SetAttribute Sets an attribute of the Web control to the specified name and value. (Inherited from WebControl.)
Explicit interface implemetation Private method ICompositeControlDesignerAccessor.RecreateChildControls Enables a designer to recreate the composite control's collection of child controls in the design-time environment. (Inherited from CompositeControl.)
Explicit interface implemetation Private property IControlBuilderAccessor.ControlBuilder For a description of this member, see IControlBuilderAccessor.ControlBuilder. (Inherited from Control.)
Explicit interface implemetation Private method IControlDesignerAccessor.GetDesignModeState For a description of this member, see IControlDesignerAccessor.GetDesignModeState. (Inherited from Control.)
Explicit interface implemetation Private method IControlDesignerAccessor.SetDesignModeState For a description of this member, see IControlDesignerAccessor.SetDesignModeState. (Inherited from Control.)
Explicit interface implemetation Private method IControlDesignerAccessor.SetOwnerControl Infrastructure. For a description of this member, see IControlDesignerAccessor.SetOwnerControl. (Inherited from Control.)
Explicit interface implemetation Private property IControlDesignerAccessor.UserData For a description of this member, see IControlDesignerAccessor.UserData. (Inherited from Control.)
Explicit interface implemetation Private property IDataBindingsAccessor.DataBindings For a description of this member, see IDataBindingsAccessor.DataBindings. (Inherited from Control.)
Explicit interface implemetation Private property IDataBindingsAccessor.HasDataBindings For a description of this member, see IDataBindingsAccessor.HasDataBindings. (Inherited from Control.)
Explicit interface implemetation Private property IExpressionsAccessor.Expressions For a description of this member, see IExpressionsAccessor.Expressions. (Inherited from Control.)
Explicit interface implemetation Private property IExpressionsAccessor.HasExpressions For a description of this member, see IExpressionsAccessor.HasExpressions. (Inherited from Control.)
Explicit interface implemetation Private method IParserAccessor.AddParsedSubObject For a description of this member, see IParserAccessor.AddParsedSubObject. (Inherited from Control.)
Explicit interface implemetation Private method IPostBackEventHandler.RaisePostBackEvent For a description of this member, see RaisePostBackEvent.
Top

In the Web Parts control set, a zone is a composite control, rendered as an HTML table, that contains other controls in a defined region of a Web page. The WebPartZoneBase class is a zone that inherits from the base WebZone class and provides a base set of behaviors for derived zones that contain WebPart controls, server controls, and user controls. The combination of WebPartZoneBase zones with WebPart (and other server) controls forms the primary UI of a Web Parts application, the normal view of a page that users interact with most of the time.

All zones provide a common set of UI elements for the controls they contain. For a detailed discussion of the UI elements common to all zones, see the class overview topic for the WebZone class. The WebPartZoneBase zone includes a body section that contains server controls, and an associated WebPartChrome object used for rendering the contained controls and their chrome elements, such as their verbs, borders, and so on.

In addition to the features inherited from the WebZone class, the WebPartZoneBase class adds client-side control dragging, specific verbs (to enable common UI actions such as minimizing, closing, deleting, and editing controls), and additional style features. The WebPartZoneBase class is also the class to inherit from if you want to design a custom zone that is database-driven. For example, you could create a custom weather Web Parts zone that inherits from WebPartZoneBase, and is designed to contain and provide layout features and other services for WebPart controls that are data-bound and display weather information.

The WebPartZoneBase class contains a number of properties for working with style attributes in a zone. There are several properties for borders, including BorderStyle and BorderWidth. There is a group of properties for working with style attributes of menus that can appear in the header of a zone, such as MenuLabelStyle, MenuVerbStyle, and others.

The WebPartZoneBase class also contains a number of members for handling verbs in a zone. These members relate to the verbs that appear on the part controls in the zone. While zone-level verbs can be added to WebPartZoneBase zones, by default they do not have any. There is a set of standard verbs provided with the Web Parts control set for use with part controls, and developers can add custom verbs as well. Some important properties for working with verbs include properties that reference some of the standard verb objects, such as CloseVerb, ConnectVerb, DeleteVerb, and EditVerb, HelpVerb, and MinimizeVerb. The standard verbs appear on a verbs menu (typically presented in the UI as a drop-down menu) in the title bar of each control contained in a zone. There is also a VerbButtonType property that allows you to determine what type of clickable object represents a verb in the UI.

Other key members for working with verbs include the OnCreateVerbs method, which is an event handler that can be overridden for custom handling of the verb creation process, and the CreateVerbs event.

The WebPartZoneBase class contains a number of members for working with WebPart controls contained within a zone. The WebParts property references the collection of all WebPart (and other server) controls in the zone. Several methods correspond to the standard verbs or actions that a user can carry out on WebPart controls in a zone, such as CloseWebPart, ConnectWebPart, and EditWebPart.

There are also a number of members in the WebPartZoneBase class that concern how the WebPart controls are laid out or arranged within the zone. The AllowLayoutChange property determines whether controls can be moved among zones or rearranged within a zone by users. The LayoutOrientation property allows you to determine whether the controls in a zone are arranged horizontally or vertically.

Note Note

Internet Explorer might render the height of a WebPartZone or its contained controls in an unexpected way, depending on the orientation of the zone. For more details, see the documentation for the LayoutOrientation or the Height properties.

Other methods in the WebPartZoneBase class provide you with detailed programmatic control over the rendering of the various areas of a zone. Many of these methods override the base methods inherited from the WebZone class, to customize the rendering for zones that contain WebPart controls. Important methods include Render, RenderBody, RenderDropCue, and RenderHeader.

The following code example demonstrates the use of the WebPartZoneBase class. The code shows how a derived class, WebPartZone, is used declaratively in a Web Parts page to contain WebPart controls. The code example has four sections: the first three sections describe the code files, and the fourth explains how to run the code.

The first part of the code example is a user control that enables users to switch the page into different display modes. For more information on Web Parts display modes and a description of the 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="&nbsp;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 a code-beside file that contains the code to handle events for the main Web page. The code in this file shows how to work with some of the key WebPartZoneBase members programmatically.


using System;
using System.Text;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;

public partial class WebPartZoneBase_overview : System.Web.UI.Page
{
  protected void Page_Load(Object sender, EventArgs e)
  {
    Label1.Text = DateTime.Now.ToLongDateString();
    Label2.Text = String.Empty;
  }

  protected void Button1_Click(object sender, EventArgs e)
  {
    if (WebPartZone2.VerbButtonType == ButtonType.Button)
      WebPartZone2.VerbButtonType = ButtonType.Link;
    else
      WebPartZone2.VerbButtonType = ButtonType.Button;
  }

  protected void Button2_Click(object sender, EventArgs e)
  {
    if (WebPartZone1.LayoutOrientation == Orientation.Vertical)
      WebPartZone1.LayoutOrientation = Orientation.Horizontal;
    else
      WebPartZone1.LayoutOrientation = Orientation.Vertical;
    Page_Load(sender, e);
  }

  protected void Button3_Click(object sender, EventArgs e)
  {
    StringBuilder builder = new StringBuilder();
    builder.AppendLine(@"<strong>WebPartZone1 WebPart IDs</strong><br />");
    foreach (WebPart part in WebPartZone1.WebParts)
    {
      builder.AppendLine("ID: " + part.ID 
                          + "; Type:  " + part.GetType() 
                          + @"<br />");
    }
    Label2.Text = builder.ToString();
    Label2.Visible = true;
  }

  protected void Button4_Click(object sender, EventArgs e)
  {
    StringBuilder builder = new StringBuilder();
    builder.AppendLine(@"<strong>WebPartZone1 DisplayTitle Property</strong><br />");
    builder.AppendLine(WebPartZone1.DisplayTitle + @"<br />");
    Label2.Text = builder.ToString();
    Label2.Visible = true;
  }
}


The third part of the code example is the Web page that contains the WebPartZone controls that exhibit behavior from the base WebPartZoneBase class, and WebPart controls contained in the zones.


<%@ Page Language="C#" 
  Codefile="webpartzonebase_overview.cs"
  Inherits="WebPartZoneBase_overview"  %>
<%@ 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">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head runat="server">
    <title>WebPartZoneBase Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <asp:WebPartManager ID="WebPartManager1" Runat="server" />
      <uc1:DisplayModeMenuCS ID="DisplayModeMenu1" runat="server" />
      <table width="75%">
        <tr>
          <td>
            <asp:WebPartZone 
              ID="WebPartZone1" 
              Runat="server"
              LayoutOrientation="Vertical" >
              <EditVerb Text="Edit WebPart" />
              <SelectedPartChromeStyle BackColor="LightBlue" />
              <ZoneTemplate>
                <asp:BulletedList 
                  ID="BulletedList1" 
                  Runat="server"
                  DisplayMode="HyperLink" 
                  Title="Favorite Links" >
                  <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>
                <asp:Calendar ID="Calendar1" Runat="server" 
                  Title="My Calendar" />
              </ZoneTemplate>
            </asp:WebPartZone>
          </td>
          <td valign="top" align="right">
            <asp:WebPartZone 
              ID="WebPartZone2"
              Runat="server" 
              DragHighlightColor="#00ff00"
              AllowLayoutChange="true"
              EmptyZoneText="Add WebParts to this empty Zone."
              BorderWidth="2"
              BorderColor="DarkBlue"
              BorderStyle="Dashed" 
              MenuLabelText="Verbs Menu" 
              MenuPopupImageUrl="label.gif" >
              <VerbStyle Font-Italic="true" />
              <MenuLabelStyle BackColor="Lime" BorderWidth="1"  />
              <MenuLabelHoverStyle Font-Bold="true" />
              <MenuVerbHoverStyle BackColor="LightGrey" />
              <MenuVerbStyle Font-Italic="true" /> 
              <ZoneTemplate>
                <asp:Label ID="Label1" Runat="server" Title="Date" />
              </ZoneTemplate>
            </asp:WebPartZone>
          </td>
        </tr>
        <tr>
          <td>
            <asp:EditorZone ID="EditorZone1" Runat="server">
              <ZoneTemplate>
                <asp:AppearanceEditorPart ID="AppearanceEditorPart1" 
                  Runat="server" />
                <asp:LayoutEditorPart ID="LayoutEditorPart1" 
                  Runat="server" />
              </ZoneTemplate>
            </asp:EditorZone>      
          </td>
        </tr>
      </table>
    </div>
    <asp:Button ID="Button1" Runat="server" 
      Width="200" Text="Toggle WebPartZone2 Buttons" 
      OnClick="Button1_Click" />
    <br />
    <asp:Button ID="Button2" Runat="server" 
      Width="200"  Text="Toggle Layout Orientation" 
      OnClick="Button2_Click" />
    <br />
    <asp:Button ID="Button3" Runat="server" 
      Width="200" Text="List WebPartZone1 WebParts" 
      OnClick="Button3_Click" />
    <br />
    <asp:Button ID="Button4" Runat="server" 
      Width="200" Text="WebPartZone1 Display Title" 
      OnClick="Button4_Click" />
    <br />
    <asp:Label ID="Label2" Runat="server" Visible="false" />
    </form>
</body>
</html>


Load the Web page in a browser. Use the Display Mode drop-down list control to switch the page into design mode, click the WebPart controls, and try dragging them between the visible zones. Click some of the buttons on the page to see the effect of using various members of the WebPartZoneBase class. Next, switch the page to edit mode. Make sure a WebPart control is positioned in WebPartZone2, click the verbs menu on the control's title bar, and click Edit to edit the control. Finish editing that control, and then edit one of the controls in the other zone. As you carry out these steps, notice the differences in the UI styles of the controls and the zones, which are the effect of using the various members of the WebPartZoneBase class.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ