This documentation is archived and is not being maintained.
WebPartZoneBase Members
Visual Studio 2008
Serves as the base class for all zone controls that act as containers for WebPart (or other server or user) controls.
The WebPartZoneBase type exposes the following members.
| Name | Description | |
|---|---|---|
|
WebPartZoneBase | Initializes the class for use by an inherited class instance. This constructor can only be called by an inherited class. |
| Name | Description | |
|---|---|---|
|
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.) |
|
AddedControl | Called after a child control is added to the Controls collection of the Control object. (Inherited from Control.) |
|
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.) |
|
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.) |
|
ApplyStyleSheetSkin | Applies the style properties defined in the page style sheet to the control. (Inherited from Control.) |
|
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.) |
|
ClearChildControlState | Deletes the control-state information for the server control's child controls. (Inherited from Control.) |
|
ClearChildState | Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.) |
|
ClearChildViewState | Deletes the view-state information for all the server control's child controls. (Inherited from Control.) |
|
CloseWebPart | Closes a selected WebPart control in a zone. |
|
ConnectWebPart | Initiates the process of creating a connection between two WebPart controls. |
|
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.) |
|
CreateChildControls | Creates the set of child controls contained in a zone. (Overrides Control::CreateChildControls().) |
|
CreateControlCollection | Infrastructure. Creates a ControlCollection object that contains all the controls in a zone. (Overrides Control::CreateControlCollection().) |
|
CreateControlStyle | Creates a set of style characteristics that apply to a zone control when it is visible. (Overrides WebControl::CreateControlStyle().) |
|
CreateWebPartChrome | Enables derived zones to substitute a custom WebPartChrome object to change the appearance of WebPart controls in a zone. |
|
DataBind | Overloaded. Binds a data source to the invoked server control and all its child controls. |
|
DataBindChildren | Binds a data source to the server control's child controls. (Inherited from Control.) |
|
DeleteWebPart | Deletes a selected WebPart control in a zone. |
|
Dispose | Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.) |
|
EditWebPart | Initiates the process of editing a selected WebPart control in a zone. |
|
EnsureChildControls | Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.) |
|
EnsureID | Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.) |
|
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
FindControl | Overloaded. Searches the current naming container for the specified server control. |
|
Focus | Sets input focus to a control. (Inherited from Control.) |
|
GetDesignModeState | Infrastructure. Gets design-time data for a control. (Inherited from Control.) |
|
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).) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetInitialWebParts | Gets an initial collection of WebPart controls contained in a zone, based on a template or some storage medium. |
|
GetType | Gets the type of the current instance. (Inherited from Object.) |
|
HasControls | Determines if the server control contains any child controls. (Inherited from Control.) |
|
HasEvents | Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.) |
|
IsLiteralContent | Infrastructure. Determines if the server control holds only literal content. (Inherited from Control.) |
|
LoadControlState | Restores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.) |
|
LoadViewState | Loads previously saved state information for a zone. (Overrides WebZone::LoadViewState(Object).) |
|
MapPathSecure | Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
MergeStyle | 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.) |
|
MinimizeWebPart | Minimizes a selected WebPart control in a zone. |
|
OnBubbleEvent | Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.) |
|
OnCreateVerbs | Raises the CreateVerbs event. |
|
OnDataBinding | Raises the DataBinding event. (Inherited from Control.) |
|
OnInit | Raises the Init event. (Inherited from WebZone.) |
|
OnLoad | Raises the Load event. (Inherited from Control.) |
|
OnPreRender | Raises the PreRender event. (Overrides WebZone::OnPreRender(EventArgs).) |
|
OnUnload | Raises the Unload event. (Inherited from Control.) |
|
OpenFile | Gets a Stream used to read a file. (Inherited from Control.) |
|
RaiseBubbleEvent | Assigns any sources of the event and its information to the control's parent. (Inherited from Control.) |
|
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. |
|
RecreateChildControls | Recreates the child controls in a control derived from CompositeControl. (Inherited from CompositeControl.) |
|
RemovedControl | Called after a child control is removed from the Controls collection of the Control object. (Inherited from Control.) |
|
Render | Renders the zone to the specified HtmlTextWriter object. (Overrides CompositeControl::Render(HtmlTextWriter).) |
|
RenderBeginTag | Renders the opening HTML tag of the zone control to the specified HtmlTextWriter object. (Inherited from WebZone.) |
|
RenderBody | Overrides the base method to render the body area of a zone derived from the WebPartZoneBase class. (Overrides WebZone::RenderBody(HtmlTextWriter).) |
|
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.) |
|
RenderContents | Renders the entire contents of a zone control between the beginning and ending tags to the specified HtmlTextWriter object. (Inherited from WebZone.) |
|
RenderControl | Overloaded. Outputs server control content and stores tracing information about the control if tracing is enabled. |
|
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. |
|
RenderEndTag | Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.) |
|
RenderFooter | Overrides rendering for the footer of a zone control. (Inherited from WebZone.) |
|
RenderHeader | Overrides the base method to render the header of a WebPartZoneBase zone that contains WebPart controls. (Overrides WebZone::RenderHeader(HtmlTextWriter).) |
|
ResolveAdapter | Gets the control adapter responsible for rendering the specified control. (Inherited from Control.) |
|
ResolveClientUrl | Gets a URL that can be used by the browser. (Inherited from Control.) |
|
ResolveUrl | Converts a URL into one that is usable on the requesting client. (Inherited from Control.) |
|
RestoreWebPart | Restores a selected WebPart control that was minimized to normal state. |
|
SaveControlState | Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.) |
|
SaveViewState | Saves any view-state changes that have occurred after a page was posted back to the server. (Overrides WebZone::SaveViewState().) |
|
SetDesignModeState | Sets design-time data for a control. (Inherited from Control.) |
|
SetRenderMethodDelegate | Infrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
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().) |
| Name | Description | |
|---|---|---|
|
FindDataSourceControl | Returns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.) |
|
FindFieldTemplate | Returns the field template for the specified column within the specified control's naming container. (Defined by DynamicDataExtensions.) |
|
FindMetaTable | Returns the MetaTable object for the containing data control. (Defined by DynamicDataExtensions.) |
| Name | Description | |
|---|---|---|
|
AccessKey | Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.) |
|
Adapter | Gets the browser-specific adapter for the control. (Inherited from Control.) |
|
AllowLayoutChange | Gets or sets a value that indicates whether the layout of WebPart controls can be changed within a zone. |
|
AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.) |
|
Attributes | Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.) |
|
BackColor | Gets or sets the background color of the Web server control. (Inherited from WebControl.) |
|
BackImageUrl | Gets or sets the URL to a background image for a zone. (Inherited from WebZone.) |
|
BindingContainer | Infrastructure. Gets the control that contains this control's data binding. (Inherited from Control.) |
|
BorderColor | Gets or sets the color for the border of a WebPartZoneBase control. (Overrides WebControl::BorderColor.) |
|
BorderStyle | Gets or sets the kind of border that surrounds a WebPartZoneBase control. (Overrides WebControl::BorderStyle.) |
|
BorderWidth | Gets or sets the width of the border that surrounds a WebPartZoneBase control. (Overrides WebControl::BorderWidth.) |
|
ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.) |
|
ClientID | Gets the server control identifier generated by ASP.NET. (Inherited from Control.) |
|
ClientIDSeparator | Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.) |
|
CloseVerb | Gets a reference to a WebPartVerb object that enables end users to close the WebPart controls in a zone. |
|
ConnectVerb | Gets a reference to a WebPartVerb object that enables end users to create connections between WebPart controls. |
|
Context | Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.) |
|
Controls | Gets a ControlCollection object that represents the child controls in a CompositeControl. (Inherited from CompositeControl.) |
|
ControlStyle | Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.) |
|
ControlStyleCreated | Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from WebControl.) |
|
CssClass | Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.) |
|
DeleteVerb | Gets a reference to a WebPartVerb object that enables end users to delete the WebPart controls in a zone. |
|
DesignMode | Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.) |
|
DisplayTitle | Gets the current value of the text being used as the title for a WebPartZoneBase zone when the zone itself is visible. |
|
DragDropEnabled | Gets a value that indicates whether WebPart controls can be dragged into or out of a zone. |
|
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. |
|
EditVerb | Gets a reference to a WebPartVerb object that enables end users to edit WebPart controls in a zone. |
|
EmptyZoneText | Gets or sets a message that appears when a WebPartZoneBase control contains no WebPart controls. (Overrides WebZone::EmptyZoneText.) |
|
EmptyZoneTextStyle | Gets the style attributes for the placeholder text in an empty zone. (Inherited from WebZone.) |
|
Enabled | Gets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.) |
|
EnableTheming | Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.) |
|
EnableViewState | Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control.) |
|
ErrorStyle | Gets the style attributes for rendering the error message that is displayed if a WebPart control cannot be loaded or created. (Inherited from WebZone.) |
|
Events | Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.) |
|
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. |
|
Font | Gets the font properties associated with the Web server control. (Inherited from WebControl.) |
|
FooterStyle | Gets the style attributes for the contents of a zone's footer area. (Inherited from WebZone.) |
|
ForeColor | Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.) |
|
HasAttributes | Gets a value indicating whether the control has attributes set. (Inherited from WebControl.) |
|
HasChildViewState | Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.) |
|
HasFooter | Gets a value indicating whether a zone has a footer area. (Overrides WebZone::HasFooter.) |
|
HasHeader | Gets a value indicating whether a zone has a header area. (Overrides WebZone::HasHeader.) |
|
HeaderStyle | Gets the style attributes for the contents of a zone's header area. (Inherited from WebZone.) |
|
HeaderText | Gets or sets the text for the header area of a zone. (Inherited from WebZone.) |
|
Height | Gets or sets the height of the Web server control. (Inherited from WebControl.) |
|
HelpVerb | Gets a reference to a WebPartVerb object used to access Help content for WebPart controls in a zone. |
|
ID | Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.) |
|
IdSeparator | Infrastructure. Gets the character used to separate control identifiers. (Inherited from Control.) |
|
IsChildControlStateCleared | Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.) |
|
IsEnabled | Gets a value indicating whether the control is enabled. (Inherited from WebControl.) |
|
IsTrackingViewState | Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.) |
|
IsViewStateEnabled | Gets a value indicating whether view state is enabled for this control. (Inherited from Control.) |
|
LayoutOrientation | Gets or sets a value that indicates whether controls in a zone are arranged vertically or horizontally. |
|
LoadViewStateByID | Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.) |
|
MenuCheckImageStyle | Gets style attributes that are applied to the check mark image that appears on a verbs menu next to the selected verb text. |
|
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. |
|
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. |
|
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. |
|
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. |
|
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. |
|
MenuPopupStyle | Gets style attributes for the drop-down verbs menu that appears on WebPart controls in a zone. |
|
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. |
|
MenuVerbStyle | Gets style information for the appearance of a verb in a verbs drop-down menu when the menu is displayed. |
|
MinimizeVerb | Gets a reference to a WebPartVerb object that enables end users to minimize WebPart controls in a zone. |
|
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.) |
|
Padding | Gets or sets the cell padding attributes on the table that contains the WebPart controls in a zone. (Inherited from WebZone.) |
|
Page | Gets a reference to the Page instance that contains the server control. (Inherited from Control.) |
|
Parent | Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.) |
|
PartChromePadding | Gets or sets the distance between the contents of a WebPart control and the border of the control. (Inherited from WebZone.) |
|
PartChromeStyle | Gets style characteristics that apply to the borders of Web Parts controls contained by a zone. (Inherited from WebZone.) |
|
PartChromeType | Gets or sets the type of border that frames Web Parts controls contained by a zone. (Inherited from WebZone.) |
|
PartStyle | Gets style characteristics that apply to the border and contents of each Web Parts control contained by a zone. (Inherited from WebZone.) |
|
PartTitleStyle | Gets style attributes for the title bar content for each Web Parts control contained by a zone. (Inherited from WebZone.) |
|
RenderClientScript | Gets a value that indicates whether to render client script on a Web Parts page. (Inherited from WebZone.) |
|
RestoreVerb | Gets a reference to a WebPartVerb object that enables end users to restore WebPart controls in a zone to normal size. |
|
SelectedPartChromeStyle | Gets style information for the appearance of a selected WebPart control in a zone. |
|
ShowTitleIcons | Gets or sets a value that indicates whether title icons are displayed in the title bar of each WebPart control in a zone. |
|
Site | Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.) |
|
SkinID | Gets or sets the skin to apply to the control. (Inherited from WebControl.) |
|
Style | Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from WebControl.) |
|
TabIndex | Gets or sets the tab index of the Web server control. (Inherited from WebControl.) |
|
TagKey | Gets the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers. (Inherited from WebZone.) |
|
TagName | Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.) |
|
TemplateControl | Gets or sets a reference to the template that contains this control. (Inherited from Control.) |
|
TemplateSourceDirectory | Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.) |
|
TitleBarVerbButtonType | Gets or sets the type of button used for the verbs in the title bar of WebPart controls. |
|
TitleBarVerbStyle | Gets style attributes for verbs in the title bar of a WebPart control. |
|
ToolTip | Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.) |
|
UniqueID | Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.) |
|
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.) |
|
VerbStyle | Gets the style attributes for the user interface (UI) verbs associated with Web Parts controls in a zone. (Inherited from WebZone.) |
|
ViewState | Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control.) |
|
ViewStateIgnoresCase | Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.) |
|
Visible | Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.) |
|
WebPartChrome | Gets a reference to the WebPartChrome object that determines the peripheral rendering for WebPart controls in the zone. |
|
WebPartManager | Gets a reference to the WebPartManager control associated with a WebZone control instance on a Web Parts page. (Inherited from WebZone.) |
|
WebParts | Gets the collection of Web Parts controls contained within a zone. |
|
WebPartVerbRenderMode | Gets or sets a value indicating how the verbs should be rendered on WebPart controls in the zone. |
|
Width | Gets or sets the width of the Web server control. (Inherited from WebControl.) |
| Name | Description | |
|---|---|---|
|
CreateVerbs | Occurs when the verbs are created for a zone that derives from the WebPartZoneBase class. |
|
DataBinding | Occurs when the server control binds to a data source. (Inherited from Control.) |
|
Disposed | Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control.) |
|
Init | Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.) |
|
Load | Occurs when the server control is loaded into the Page object. (Inherited from Control.) |
|
PreRender | Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.) |
|
Unload | Occurs when the server control is unloaded from memory. (Inherited from Control.) |
Top
Show: