Export (0) Print
Expand All
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.

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.

  NameDescription
Protected methodWebPartZoneBaseInitializes the class for use by an inherited class instance. This constructor can only be called by an inherited class.
Top
  NameDescription
Public propertyAccessKeyGets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.)
Protected propertyAdapterGets the browser-specific adapter for the control. (Inherited from Control.)
Public propertyAllowLayoutChangeGets or sets a value that indicates whether the layout of WebPart controls can be changed within a zone.
Public propertyAppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.)
Public propertyAttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.)
Public propertyBackColorGets or sets the background color of the Web server control. (Inherited from WebControl.)
Public propertyBackImageUrlGets or sets the URL to a background image for a zone. (Inherited from WebZone.)
Public propertyBindingContainerInfrastructure. Gets the control that contains this control's data binding. (Inherited from Control.)
Public propertyBorderColorGets or sets the color for the border of a WebPartZoneBase control. (Overrides WebControl.BorderColor.)
Public propertyBorderStyleGets or sets the kind of border that surrounds a WebPartZoneBase control. (Overrides WebControl.BorderStyle.)
Public propertyBorderWidthGets or sets the width of the border that surrounds a WebPartZoneBase control. (Overrides WebControl.BorderWidth.)
Protected propertyChildControlsCreatedGets a value that indicates whether the server control's child controls have been created. (Inherited from Control.)
Public propertyClientIDGets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.)
Public propertyClientIDModeGets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.)
Protected propertyClientIDSeparatorGets a character value representing the separator character used in the ClientID property. (Inherited from Control.)
Public propertyCloseVerbGets a reference to a WebPartVerb object that enables end users to close the WebPart controls in a zone.
Public propertyConnectVerbGets a reference to a WebPartVerb object that enables end users to create connections between WebPart controls.
Protected propertyContextGets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.)
Public propertyControlsGets a ControlCollection object that represents the child controls in a CompositeControl. (Inherited from CompositeControl.)
Public propertyControlStyleGets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
Public propertyControlStyleCreatedGets 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 propertyCssClassGets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.)
Public propertyDataItemContainerGets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.)
Public propertyDataKeysContainerGets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control.)
Public propertyDeleteVerbGets a reference to a WebPartVerb object that enables end users to delete the WebPart controls in a zone.
Protected propertyDesignModeGets a value indicating whether a control is being used on a design surface. (Inherited from Control.)
Public propertyDisplayTitleGets the current value of the text being used as the title for a WebPartZoneBase zone when the zone itself is visible.
Protected propertyDragDropEnabledGets a value that indicates whether WebPart controls can be dragged into or out of a zone.
Public propertyDragHighlightColorGets or sets the color around the border of a WebPartZoneBase zone and its drop-cue regions when a user is dragging a control.
Public propertyEditVerbGets a reference to a WebPartVerb object that enables end users to edit WebPart controls in a zone.
Public propertyEmptyZoneTextGets or sets a message that appears when a WebPartZoneBase control contains no WebPart controls. (Overrides WebZone.EmptyZoneText.)
Public propertyEmptyZoneTextStyleGets the style attributes for the placeholder text in an empty zone. (Inherited from WebZone.)
Public propertyEnabledGets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.)
Public propertyEnableThemingGets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.)
Public propertyEnableViewStateGets 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 propertyErrorStyleGets the style attributes for rendering the error message that is displayed if a WebPart control cannot be loaded or created. (Inherited from WebZone.)
Protected propertyEventsGets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.)
Public propertyExportVerbGets a reference to a WebPartVerb object that enables end users to export an XML definition file for each WebPart control in a zone.
Public propertyFontGets the font properties associated with the Web server control. (Inherited from WebControl.)
Public propertyFooterStyleGets the style attributes for the contents of a zone's footer area. (Inherited from WebZone.)
Public propertyForeColorGets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.)
Public propertyHasAttributesGets a value indicating whether the control has attributes set. (Inherited from WebControl.)
Protected propertyHasChildViewStateGets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.)
Protected propertyHasFooterGets a value indicating whether a zone has a footer area. (Overrides WebZone.HasFooter.)
Protected propertyHasHeaderGets a value indicating whether a zone has a header area. (Overrides WebZone.HasHeader.)
Public propertyHeaderStyleGets the style attributes for the contents of a zone's header area. (Inherited from WebZone.)
Public propertyHeaderTextGets or sets the text for the header area of a zone. (Inherited from WebZone.)
Public propertyHeightGets or sets the height of the Web server control. (Inherited from WebControl.)
Public propertyHelpVerbGets a reference to a WebPartVerb object used to access Help content for WebPart controls in a zone.
Public propertyIDGets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
Protected propertyIdSeparatorInfrastructure. Gets the character used to separate control identifiers. (Inherited from Control.)
Protected propertyIsChildControlStateClearedGets a value indicating whether controls contained within this control have control state. (Inherited from Control.)
Protected propertyIsEnabledGets a value indicating whether the control is enabled. (Inherited from WebControl.)
Protected propertyIsTrackingViewStateGets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.)
Protected propertyIsViewStateEnabledGets a value indicating whether view state is enabled for this control. (Inherited from Control.)
Public propertyLayoutOrientationGets or sets a value that indicates whether controls in a zone are arranged vertically or horizontally.
Protected propertyLoadViewStateByIDGets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
Public propertyMenuCheckImageStyleGets style attributes that are applied to the check mark image that appears on a verbs menu next to the selected verb text.
Public propertyMenuCheckImageUrlGets or sets the URL to an image used as a check mark in the verbs menu of each WebPart control in a zone.
Public propertyMenuLabelHoverStyleGets 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 propertyMenuLabelStyleGets 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 propertyMenuLabelTextGets 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 propertyMenuPopupImageUrlGets 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 propertyMenuPopupStyleGets style attributes for the drop-down verbs menu that appears on WebPart controls in a zone.
Public propertyMenuVerbHoverStyleGets 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 propertyMenuVerbStyleGets style information for the appearance of a verb in a verbs drop-down menu when the menu is displayed.
Public propertyMinimizeVerbGets a reference to a WebPartVerb object that enables end users to minimize WebPart controls in a zone.
Public propertyNamingContainerGets 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 propertyPaddingGets or sets the cell padding attributes on the table that contains the WebPart controls in a zone. (Inherited from WebZone.)
Public propertyPageGets a reference to the Page instance that contains the server control. (Inherited from Control.)
Public propertyParentGets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.)
Public propertyPartChromePaddingGets or sets the distance between the contents of a WebPart control and the border of the control. (Inherited from WebZone.)
Public propertyPartChromeStyleGets style characteristics that apply to the borders of Web Parts controls contained by a zone. (Inherited from WebZone.)
Public propertyPartChromeTypeGets or sets the type of border that frames Web Parts controls contained by a zone. (Inherited from WebZone.)
Public propertyPartStyleGets style characteristics that apply to the border and contents of each Web Parts control contained by a zone. (Inherited from WebZone.)
Public propertyPartTitleStyleGets style attributes for the title bar content for each Web Parts control contained by a zone. (Inherited from WebZone.)
Protected propertyRenderClientScriptGets a value that indicates whether to render client script on a Web Parts page. (Inherited from WebZone.)
Public propertyRenderingCompatibilityGets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.)
Public propertyRestoreVerbGets a reference to a WebPartVerb object that enables end users to restore WebPart controls in a zone to normal size.
Public propertySelectedPartChromeStyleGets style information for the appearance of a selected WebPart control in a zone.
Public propertyShowTitleIconsGets or sets a value that indicates whether title icons are displayed in the title bar of each WebPart control in a zone.
Public propertySiteGets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.)
Public propertySkinIDGets or sets the skin to apply to the control. (Inherited from WebControl.)
Public propertyStyleGets 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 propertySupportsDisabledAttributeGets 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 propertyTabIndexGets or sets the tab index of the Web server control. (Inherited from WebControl.)
Protected propertyTagKeyGets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from WebZone.)
Protected propertyTagNameGets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.)
Public propertyTemplateControlGets or sets a reference to the template that contains this control. (Inherited from Control.)
Public propertyTemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.)
Public propertyTitleBarVerbButtonTypeGets or sets the type of button used for the verbs in the title bar of WebPart controls.
Public propertyTitleBarVerbStyleGets style attributes for verbs in the title bar of a WebPart control.
Public propertyToolTipGets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.)
Public propertyUniqueIDGets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.)
Public propertyValidateRequestModeGets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control.)
Public propertyVerbButtonTypeGets 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 propertyVerbStyleGets the style attributes for the user interface (UI) verbs associated with Web Parts controls in a zone. (Inherited from WebZone.)
Protected propertyViewStateGets 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 propertyViewStateIgnoresCaseGets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.)
Public propertyViewStateModeGets or sets the view-state mode of this control. (Inherited from Control.)
Public propertyVisibleGets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.)
Public propertyWebPartChromeGets a reference to the WebPartChrome object that determines the peripheral rendering for WebPart controls in the zone.
Protected propertyWebPartManagerGets a reference to the WebPartManager control associated with a WebZone control instance on a Web Parts page. (Inherited from WebZone.)
Public propertyWebPartsGets the collection of Web Parts controls contained within a zone.
Public propertyWebPartVerbRenderModeGets or sets a value indicating how the verbs should be rendered on WebPart controls in the zone.
Public propertyWidthGets or sets the width of the Web server control. (Inherited from WebControl.)
Top
  NameDescription
Protected methodAddAttributesToRenderAdds 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 methodAddedControlCalled after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
Protected methodAddParsedSubObjectNotifies 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 methodApplyStyleCopies 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 methodApplyStyleSheetSkinApplies the style properties defined in the page style sheet to the control. (Inherited from Control.)
Protected methodBeginRenderTracingBegins design-time tracing of rendering data. (Inherited from Control.)
Protected methodBuildProfileTreeInfrastructure. 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 methodClearCachedClientIDInfrastructure. Sets the cached ClientID value to null. (Inherited from Control.)
Protected methodClearChildControlStateDeletes the control-state information for the server control's child controls. (Inherited from Control.)
Protected methodClearChildStateDeletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.)
Protected methodClearChildViewStateDeletes the view-state information for all the server control's child controls. (Inherited from Control.)
Protected methodClearEffectiveClientIDModeInfrastructure. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.)
Protected methodCloseWebPartCloses a selected WebPart control in a zone.
Protected methodConnectWebPartInitiates the process of creating a connection between two WebPart controls.
Public methodCopyBaseAttributesCopies 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 methodCreateChildControlsCreates the set of child controls contained in a zone. (Overrides Control.CreateChildControls().)
Protected methodCreateControlCollectionInfrastructure. Creates a ControlCollection object that contains all the controls in a zone. (Overrides Control.CreateControlCollection().)
Protected methodCreateControlStyleCreates a set of style characteristics that apply to a zone control when it is visible. (Overrides WebControl.CreateControlStyle().)
Protected methodCreateWebPartChromeEnables derived zones to substitute a custom WebPartChrome object to change the appearance of WebPart controls in a zone.
Public methodDataBind()Binds a data source to the CompositeControl and all its child controls. (Inherited from CompositeControl.)
Protected methodDataBind(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 methodDataBindChildrenBinds a data source to the server control's child controls. (Inherited from Control.)
Protected methodDeleteWebPartDeletes a selected WebPart control in a zone.
Public methodDisposeEnables a server control to perform final clean up before it is released from memory. (Inherited from Control.)
Protected methodEditWebPartInitiates the process of editing a selected WebPart control in a zone.
Protected methodEndRenderTracingEnds design-time tracing of rendering data. (Inherited from Control.)
Protected methodEnsureChildControlsDetermines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.)
Protected methodEnsureIDCreates an identifier for controls that do not have an identifier assigned. (Inherited from Control.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodFindControl(String)Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.)
Protected methodFindControl(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 methodFocusSets input focus to a control. (Inherited from Control.)
Protected methodGetDesignModeStateInfrastructure. Gets design-time data for a control. (Inherited from Control.)
Public methodGetEffectiveChromeTypeReturns 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 methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Protected methodGetInitialWebPartsGets an initial collection of WebPart controls contained in a zone, based on a template or some storage medium.
Public methodGetRouteUrl(Object)Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public methodGetRouteUrl(RouteValueDictionary)Gets the URL that corresponds to a set of route parameters. (Inherited from Control.)
Public methodGetRouteUrl(String, Object)Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public methodGetRouteUrl(String, RouteValueDictionary)Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetUniqueIDRelativeToReturns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.)
Public methodHasControlsDetermines if the server control contains any child controls. (Inherited from Control.)
Protected methodHasEventsReturns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.)
Protected methodIsLiteralContentInfrastructure. Determines if the server control holds only literal content. (Inherited from Control.)
Protected methodLoadControlStateRestores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.)
Protected methodLoadViewStateLoads previously saved state information for a zone. (Overrides WebZone.LoadViewState(Object).)
Protected methodMapPathSecureRetrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodMergeStyleCopies 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 methodMinimizeWebPartMinimizes a selected WebPart control in a zone.
Protected methodOnBubbleEventDetermines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.)
Protected methodOnCreateVerbsRaises the CreateVerbs event.
Protected methodOnDataBindingRaises the DataBinding event. (Inherited from Control.)
Protected methodOnInitRaises the Init event. (Inherited from WebZone.)
Protected methodOnLoadRaises the Load event. (Inherited from Control.)
Protected methodOnPreRenderRaises the PreRender event. (Overrides WebZone.OnPreRender(EventArgs).)
Protected methodOnUnloadRaises the Unload event. (Inherited from Control.)
Protected methodOpenFileGets a Stream used to read a file. (Inherited from Control.)
Protected methodRaiseBubbleEventAssigns any sources of the event and its information to the control's parent. (Inherited from Control.)
Protected methodRaisePostBackEventUpdates 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 methodRecreateChildControlsRecreates the child controls in a control derived from CompositeControl. (Inherited from CompositeControl.)
Protected methodRemovedControlCalled after a child control is removed from the Controls collection of the Control object. (Inherited from Control.)
Protected methodRenderRenders the zone to the specified HtmlTextWriter object. (Overrides CompositeControl.Render(HtmlTextWriter).)
Public methodRenderBeginTagRenders the opening HTML tag of the zone control to the specified HtmlTextWriter object. (Inherited from WebZone.)
Protected methodRenderBodyOverrides the base method to render the body area of a zone derived from the WebPartZoneBase class. (Overrides WebZone.RenderBody(HtmlTextWriter).)
Protected methodRenderChildrenOutputs 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 methodRenderContentsRenders the entire contents of a zone control between the beginning and ending tags to the specified HtmlTextWriter object. (Inherited from WebZone.)
Public methodRenderControl(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 methodRenderControl(HtmlTextWriter, ControlAdapter)Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.)
Protected methodRenderDropCueRenders 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 methodRenderEndTagRenders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Protected methodRenderFooterOverrides rendering for the footer of a zone control. (Inherited from WebZone.)
Protected methodRenderHeaderOverrides the base method to render the header of a WebPartZoneBase zone that contains WebPart controls. (Overrides WebZone.RenderHeader(HtmlTextWriter).)
Protected methodResolveAdapterGets the control adapter responsible for rendering the specified control. (Inherited from Control.)
Public methodResolveClientUrlGets a URL that can be used by the browser. (Inherited from Control.)
Public methodResolveUrlConverts a URL into one that is usable on the requesting client. (Inherited from Control.)
Protected methodRestoreWebPartRestores a selected WebPart control that was minimized to normal state.
Protected methodSaveControlStateSaves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.)
Protected methodSaveViewStateSaves any view-state changes that have occurred after a page was posted back to the server. (Overrides WebZone.SaveViewState().)
Protected methodSetDesignModeStateSets design-time data for a control. (Inherited from Control.)
Public methodSetRenderMethodDelegateInfrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.)
Public methodSetTraceData(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.)
Public methodSetTraceData(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.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodTrackViewStateBegins 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
  NameDescription
Public eventCreateVerbsOccurs when the verbs are created for a zone that derives from the WebPartZoneBase class.
Public eventDataBindingOccurs when the server control binds to a data source. (Inherited from Control.)
Public eventDisposedOccurs 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 eventInitOccurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.)
Public eventLoadOccurs when the server control is loaded into the Page object. (Inherited from Control.)
Public eventPreRenderOccurs after the Control object is loaded but prior to rendering. (Inherited from Control.)
Public eventUnloadOccurs when the server control is unloaded from memory. (Inherited from Control.)
Top
  NameDescription
Public Extension MethodFindDataSourceControlReturns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.)
Public Extension MethodFindFieldTemplateReturns the field template for the specified column in the specified control's naming container. (Defined by DynamicDataExtensions.)
Public Extension MethodFindMetaTableReturns the metatable object for the containing data control. (Defined by DynamicDataExtensions.)
Top
  NameDescription
Explicit interface implemetationPrivate methodIAttributeAccessor.GetAttributeInfrastructure. Gets an attribute of the Web control with the specified name. (Inherited from WebControl.)
Explicit interface implemetationPrivate methodIAttributeAccessor.SetAttributeSets an attribute of the Web control to the specified name and value. (Inherited from WebControl.)
Explicit interface implemetationPrivate methodICompositeControlDesignerAccessor.RecreateChildControlsEnables a designer to recreate the composite control's collection of child controls in the design-time environment. (Inherited from CompositeControl.)
Explicit interface implemetationPrivate propertyIControlBuilderAccessor.ControlBuilderFor a description of this member, see IControlBuilderAccessor.ControlBuilder. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor.GetDesignModeStateFor a description of this member, see IControlDesignerAccessor.GetDesignModeState. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor.SetDesignModeStateFor a description of this member, see IControlDesignerAccessor.SetDesignModeState. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor.SetOwnerControlInfrastructure. For a description of this member, see IControlDesignerAccessor.SetOwnerControl. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIControlDesignerAccessor.UserDataFor a description of this member, see IControlDesignerAccessor.UserData. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIDataBindingsAccessor.DataBindingsFor a description of this member, see IDataBindingsAccessor.DataBindings. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIDataBindingsAccessor.HasDataBindingsFor a description of this member, see IDataBindingsAccessor.HasDataBindings. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIExpressionsAccessor.ExpressionsFor a description of this member, see IExpressionsAccessor.Expressions. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIExpressionsAccessor.HasExpressionsFor a description of this member, see IExpressionsAccessor.HasExpressions. (Inherited from Control.)
Explicit interface implemetationPrivate methodIParserAccessor.AddParsedSubObjectFor a description of this member, see IParserAccessor.AddParsedSubObject. (Inherited from Control.)
Explicit interface implemetationPrivate methodIPostBackEventHandler.RaisePostBackEventFor 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.

NoteNote

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.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.