WebPartManager Class

 

Serves as the central class of the Web Parts control set, managing all the Web Parts controls, functionality, and events that occur on a Web page.

Namespace:   System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebParts.WebPartManager

[BindableAttribute(false)]
public class WebPartManager : Control, INamingContainer, IPersonalizable

NameDescription
System_CAPS_pubmethodWebPartManager()

Initializes a new instance of the WebPartManager class.

NameDescription
System_CAPS_protpropertyAdapter

Gets the browser-specific adapter for the control.(Inherited from Control.)

System_CAPS_pubpropertyAppRelativeTemplateSourceDirectory

Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.(Inherited from Control.)

System_CAPS_pubpropertyAvailableTransformers

Gets a collection of WebPartTransformer objects that are available for use in creating Web Parts connections between server controls.

System_CAPS_pubpropertyBindingContainer

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the control that contains this control's data binding.(Inherited from Control.)

System_CAPS_protpropertyChildControlsCreated

Gets a value that indicates whether the server control's child controls have been created.(Inherited from Control.)

System_CAPS_pubpropertyClientID

Gets the control ID for HTML markup that is generated by ASP.NET.(Inherited from Control.)

System_CAPS_pubpropertyClientIDMode

Gets or sets the algorithm that is used to generate the value of the ClientID property.(Inherited from Control.)

System_CAPS_protpropertyClientIDSeparator

Gets a character value representing the separator character used in the ClientID property.(Inherited from Control.)

System_CAPS_pubpropertyCloseProviderWarning

Gets or sets a warning that is displayed when a user closes a control that is acting as a provider to other controls in a connection.

System_CAPS_pubpropertyConnections

Gets a reference to the collection of all current connections on a Web page.

System_CAPS_protpropertyContext

Gets the HttpContext object associated with the server control for the current Web request.(Inherited from Control.)

System_CAPS_pubpropertyControls

Gets the collection of all WebPart, server, or user controls that are contained in WebPartZoneBase zones on a Web page and are managed by the WebPartManager control. (Overrides Control.Controls.)

System_CAPS_pubpropertyDataItemContainer

Gets a reference to the naming container if the naming container implements IDataItemContainer.(Inherited from Control.)

System_CAPS_pubpropertyDataKeysContainer

Gets a reference to the naming container if the naming container implements IDataKeysControl.(Inherited from Control.)

System_CAPS_pubpropertyDeleteWarning

Gets or sets a custom warning message displayed to end users when they delete a control.

System_CAPS_protpropertyDesignMode

Gets a value indicating whether a control is being used on a design surface.(Inherited from Control.)

System_CAPS_pubpropertyDisplayMode

Gets or sets the active display mode for a Web page that contains Web Parts controls.

System_CAPS_pubpropertyDisplayModes

Gets a read-only collection of all display modes that are associated with a WebPartManager control.

System_CAPS_protpropertyDynamicConnections

Gets the collection of all dynamic connections that currently exist on a Web page.

System_CAPS_pubpropertyEnableClientScript

Gets or sets a value that determines whether client-side scripting is enabled on the Web page that contains a WebPartManager control.

System_CAPS_pubpropertyEnableTheming

Gets a value indicating that the use of themes is enabled on a Web page.(Overrides Control.EnableTheming.)

System_CAPS_pubpropertyEnableViewState

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

System_CAPS_protpropertyEvents

Gets a list of event handler delegates for the control. This property is read-only.(Inherited from Control.)

System_CAPS_pubpropertyExportSensitiveDataWarning

Gets or sets the text of a warning message that is displayed when a user attempts to export sensitive state data from a WebPart control.

System_CAPS_protpropertyHasChildViewState

Gets a value indicating whether the current server control's child controls have any saved view-state settings.(Inherited from Control.)

System_CAPS_pubpropertyID

Gets or sets the programmatic identifier assigned to the server control.(Inherited from Control.)

System_CAPS_protpropertyIdSeparator

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the character used to separate control identifiers.(Inherited from Control.)

System_CAPS_protpropertyInternals

Gets a reference to the WebPartManagerInternals class, which is used to combine and separate a set of methods that are actually implemented in the WebPartManager class, but are mostly useful for control developers.

System_CAPS_protpropertyIsChildControlStateCleared

Gets a value indicating whether controls contained within this control have control state.(Inherited from Control.)

System_CAPS_protpropertyIsCustomPersonalizationStateDirty

Gets a value that indicates whether personalization changes have been made that affect page-level personalization details controlled by the WebPartManager control.

System_CAPS_protpropertyIsTrackingViewState

Gets a value that indicates whether the server control is saving changes to its view state.(Inherited from Control.)

System_CAPS_protpropertyIsViewStateEnabled

Gets a value indicating whether view state is enabled for this control.(Inherited from Control.)

System_CAPS_protpropertyLoadViewStateByID

Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)

System_CAPS_protpropertyMediumPermissionSet

Gets a PermissionSet object that allows only SecurityPermissionFlag.Execution permission and AspNetHostingPermissionLevel.Medium permission.

System_CAPS_protpropertyMinimalPermissionSet

Gets a PermissionSet object that allows only SecurityPermissionFlag.Execution permission and AspNetHostingPermissionLevel.Minimal permission.

System_CAPS_pubpropertyNamingContainer

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

System_CAPS_pubpropertyPage

Gets a reference to the Page instance that contains the server control.(Inherited from Control.)

System_CAPS_pubpropertyParent

Gets a reference to the server control's parent control in the page control hierarchy.(Inherited from Control.)

System_CAPS_pubpropertyPersonalization

Gets a reference to an object that contains personalization data for a Web page.

System_CAPS_pubpropertyRenderingCompatibility

Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with.(Inherited from Control.)

System_CAPS_pubpropertySelectedWebPart

Gets a reference to a WebPart or other server control that is currently selected for editing or for creating a connection with another control.

System_CAPS_pubpropertySite

Gets information about the container that hosts the current control when rendered on a design surface.(Inherited from Control.)

System_CAPS_pubpropertySkinID

Gets or sets an empty string ("") so that no skin can be applied to the WebPartManager control. (Overrides Control.SkinID.)

System_CAPS_pubpropertyStaticConnections

Gets a reference to the collection of all WebPartConnection objects on a Web page that are defined as static connections.

System_CAPS_pubpropertySupportedDisplayModes

Gets a read-only collection of all display modes that are available on a particular Web page.

System_CAPS_pubpropertyTemplateControl

Gets or sets a reference to the template that contains this control. (Inherited from Control.)

System_CAPS_pubpropertyTemplateSourceDirectory

Gets the virtual directory of the Page or UserControl that contains the current server control.(Inherited from Control.)

System_CAPS_pubpropertyUniqueID

Gets the unique, hierarchically qualified identifier for the server control.(Inherited from Control.)

System_CAPS_pubpropertyValidateRequestMode

Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values.(Inherited from Control.)

System_CAPS_protpropertyViewState

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

System_CAPS_protpropertyViewStateIgnoresCase

Gets a value that indicates whether the StateBag object is case-insensitive.(Inherited from Control.)

System_CAPS_pubpropertyViewStateMode

Gets or sets the view-state mode of this control.(Inherited from Control.)

System_CAPS_pubpropertyVisible

Gets a value that enables child controls to be visible.(Overrides Control.Visible.)

System_CAPS_pubpropertyWebParts

Gets a reference to all WebPart controls tracked by the WebPartManager control on a Web page.

System_CAPS_pubpropertyZones

Gets a reference to a collection of all the WebPartZoneBase zones on a Web page.

NameDescription
System_CAPS_protmethodActivateConnections()

Makes active all connections on a Web page that are currently inactive.

System_CAPS_protmethodAddedControl(Control, Int32)

Called after a child control is added to the Controls collection of the Control object.(Inherited from Control.)

System_CAPS_protmethodAddParsedSubObject(Object)

Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.(Inherited from Control.)

System_CAPS_pubmethodAddWebPart(WebPart, WebPartZoneBase, Int32)

Provides the standard programmatic method for adding WebPart controls to a Web page.

System_CAPS_pubmethodApplyStyleSheetSkin(Page)

Applies the style properties defined in the page style sheet to the control.(Inherited from Control.)

System_CAPS_protmethodBeginRenderTracing(TextWriter, Object)

Begins design-time tracing of rendering data.(Inherited from Control.)

System_CAPS_pubmethodBeginWebPartConnecting(WebPart)

Starts the process of connecting two WebPart controls.

System_CAPS_pubmethodBeginWebPartEditing(WebPart)

Starts the process of editing a WebPart control.

System_CAPS_protmethodBuildProfileTree(String, Boolean)

This API supports the product infrastructure and is not intended to be used directly from your code. 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.)

System_CAPS_pubmethodCanConnectWebParts(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint)

Checks the WebPart controls that will be participating in a connection to determine whether they are capable of being connected, when the consumer and provider controls have compatible interfaces and a WebPartTransformer object is not needed.

System_CAPS_pubmethodCanConnectWebParts(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint, WebPartTransformer)

Checks the WebPart controls that will be participating in a connection to determine whether they are capable of being connected, and uses a WebPartTransformer object to create the connection between an incompatible consumer and provider.

System_CAPS_protmethodCheckRenderClientScript()

Checks the capabilities of the browser making the request, and the value of the EnableClientScript property, to determine whether to render client script.

System_CAPS_protmethodClearCachedClientID()

This API supports the product infrastructure and is not intended to be used directly from your code. Sets the cached ClientID value to null.(Inherited from Control.)

System_CAPS_protmethodClearChildControlState()

Deletes the control-state information for the server control's child controls. (Inherited from Control.)

System_CAPS_protmethodClearChildState()

Deletes the view-state and control-state information for all the server control's child controls.(Inherited from Control.)

System_CAPS_protmethodClearChildViewState()

Deletes the view-state information for all the server control's child controls.(Inherited from Control.)

System_CAPS_protmethodClearEffectiveClientIDMode()

This API supports the product infrastructure and is not intended to be used directly from your code. Sets the ClientIDMode property of the current control instance and of any child controls to Inherit.(Inherited from Control.)

System_CAPS_pubmethodCloseWebPart(WebPart)

Closes a WebPart control in such a way that it is not rendered on a Web page, but can be reopened.

System_CAPS_pubmethodConnectWebParts(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint)

Creates a connection between two WebPart or GenericWebPart controls using only the references to the controls and their specified ConnectionPoint objects.

System_CAPS_pubmethodConnectWebParts(WebPart, ProviderConnectionPoint, WebPart, ConsumerConnectionPoint, WebPartTransformer)

Creates a connection between two WebPart or GenericWebPart controls using the references to the controls, their specified ConnectionPoint objects, and a WebPartTransformer object.

System_CAPS_protmethodCopyWebPart(WebPart)

Used by the Web Parts control set to create a copy of a WebPart or server control for the purpose of adding the control to a Web page.

System_CAPS_protmethodCreateAvailableTransformers()

Creates a set of transformers specified in a Web site's configuration file and adds them to the collection of transformers referenced by the AvailableTransformers property.

System_CAPS_protmethodCreateChildControls()

Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.(Inherited from Control.)

System_CAPS_protmethodCreateControlCollection()

Returns the collection of all controls that are managed by the WebPartManager control on a Web page. This class cannot be inherited.(Overrides Control.CreateControlCollection().)

System_CAPS_protmethodCreateDisplayModes()

Creates the set of all possible display modes for a Web Parts application.

System_CAPS_protmethodCreateDynamicConnectionID()

Gets a unique value to serve as an ID for a dynamic connection.

System_CAPS_protmethodCreateDynamicWebPartID(Type)

Generates a unique ID for a dynamic WebPart control.

System_CAPS_protmethodCreateErrorWebPart(String, String, String, String, String)

Creates a special control that is inserted into a page and displayed for end users, when an attempt to load or create a dynamic WebPart control fails for some reason.

System_CAPS_protmethodCreatePersonalization()

Returns a personalization object to contain a user's personalization data for the current Web page.

System_CAPS_pubmethodCreateWebPart(Control)

Wraps a server control that is not a WebPart control with a GenericWebPart object, so that the control can have Web Parts functionality.

System_CAPS_pubmethodDataBind()

Binds a data source to the invoked server control and all its child controls.(Inherited from Control.)

System_CAPS_protmethodDataBind(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.)

System_CAPS_protmethodDataBindChildren()

Binds a data source to the server control's child controls.(Inherited from Control.)

System_CAPS_pubmethodDeleteWebPart(WebPart)

Permanently removes a dynamic instance of a WebPart control from a Web page.

System_CAPS_protmethodDisconnectWebPart(WebPart)

Removes a WebPart or server control that is being closed or deleted from any connections it is participating in.

System_CAPS_pubmethodDisconnectWebParts(WebPartConnection)

Carries out the process of disconnecting server controls that are connected on a Web page.

System_CAPS_pubmethodDispose()

Enables a server control to perform final clean up before it is released from memory.(Inherited from Control.)

System_CAPS_protmethodEndRenderTracing(TextWriter, Object)

Ends design-time tracing of rendering data.(Inherited from Control.)

System_CAPS_pubmethodEndWebPartConnecting()

Completes the process of connecting a WebPart control to another control.

System_CAPS_pubmethodEndWebPartEditing()

Completes the process of editing a WebPart control.

System_CAPS_protmethodEnsureChildControls()

Determines whether the server control contains child controls. If it does not, it creates child controls.(Inherited from Control.)

System_CAPS_protmethodEnsureID()

Creates an identifier for controls that do not have an identifier assigned.(Inherited from Control.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodExportWebPart(WebPart, XmlWriter)

Creates an XML description file that contains state and property data for a server control.

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodFindControl(String)

Searches the current naming container for a server control with the specified id parameter.(Inherited from Control.)

System_CAPS_protmethodFindControl(String, Int32)

This API supports the product infrastructure and is not intended to be used directly from your code. 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.)

System_CAPS_pubmethodFocus()

Overridden to prevent focus from ever being set on the WebPartManager control, because it has no user interface (UI).(Overrides Control.Focus().)

System_CAPS_pubmethodGetConsumerConnectionPoints(WebPart)

Retrieves the collection of ConsumerConnectionPoint objects that can act as connection points from a server control that is acting as a consumer within a Web Parts connection.

System_CAPS_pubmethodSystem_CAPS_staticGetCurrentWebPartManager(Page)

Retrieves a reference to the current instance of the WebPartManager control on a page.

System_CAPS_protmethodGetDesignModeState()

This API supports the product infrastructure and is not intended to be used directly from your code. Gets design-time data for a control.(Inherited from Control.)

System_CAPS_protmethodGetDisplayTitle(WebPart)

Gets a string containing the value for the DisplayTitle property of a WebPart control.

System_CAPS_pubmethodGetExportUrl(WebPart)

Gets the relative virtual path and the query string that are part of the request when a user attempts to export a WebPart control.

System_CAPS_pubmethodGetGenericWebPart(Control)

Gets a reference to the instance of the GenericWebPart control that contains a server control.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetProviderConnectionPoints(WebPart)

Retrieves the collection of ProviderConnectionPoint objects that can act as connection points from a server control that is acting as a provider within a Web Parts connection.

System_CAPS_pubmethodGetRouteUrl(Object)

Gets the URL that corresponds to a set of route parameters.(Inherited from Control.)

System_CAPS_pubmethodGetRouteUrl(RouteValueDictionary)

Gets the URL that corresponds to a set of route parameters.(Inherited from Control.)

System_CAPS_pubmethodGetRouteUrl(String, Object)

Gets the URL that corresponds to a set of route parameters and a route name.(Inherited from Control.)

System_CAPS_pubmethodGetRouteUrl(String, RouteValueDictionary)

Gets the URL that corresponds to a set of route parameters and a route name.(Inherited from Control.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetUniqueIDRelativeTo(Control)

Returns the prefixed portion of the UniqueID property of the specified control.(Inherited from Control.)

System_CAPS_pubmethodHasControls()

Determines if the server control contains any child controls.(Inherited from Control.)

System_CAPS_protmethodHasEvents()

Returns a value indicating whether events are registered for the control or any child controls.(Inherited from Control.)

System_CAPS_pubmethodImportWebPart(XmlReader, String)

Imports an XML description file that contains state and property data for a WebPart control, and applies the data to the control.

System_CAPS_pubmethodIsAuthorized(Type, String, String, Boolean)

Carries out the final steps in determining whether a control is authorized to be added to a page.

System_CAPS_pubmethodIsAuthorized(WebPart)

Carries out the initial steps in determining whether a control is authorized to be added to a page.

System_CAPS_protmethodIsLiteralContent()

This API supports the product infrastructure and is not intended to be used directly from your code. Determines if the server control holds only literal content.(Inherited from Control.)

System_CAPS_protmethodLoadControlState(Object)

Loads control state data that was saved from a previous page request, and needs to be restored on a subsequent request. (Overrides Control.LoadControlState(Object).)

System_CAPS_protmethodLoadCustomPersonalizationState(PersonalizationDictionary)

Stores the custom personalization data that has been passed to the WebPartManager control by the personalization objects to be used later during the initialization process.

System_CAPS_protmethodLoadViewState(Object)

Restores view-state information from a previous page request that was saved by the SaveViewState method.(Inherited from Control.)

System_CAPS_protmethodMapPathSecure(String)

Retrieves the physical path that a virtual path, either absolute or relative, maps to.(Inherited from Control.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodMoveWebPart(WebPart, WebPartZoneBase, Int32)

Moves a WebPart or server control from one WebPartZoneBase zone to another, or to a new position within the same zone.

System_CAPS_protmethodOnAuthorizeWebPart(WebPartAuthorizationEventArgs)

Raises the AuthorizeWebPart event and invokes a handler for the event, if one exists.

System_CAPS_protmethodOnBubbleEvent(Object, EventArgs)

Determines whether the event for the server control is passed up the page's UI server control hierarchy.(Inherited from Control.)

System_CAPS_protmethodOnConnectionsActivated(EventArgs)

Raises the ConnectionsActivated event to indicate that a page and its controls are loaded, and connections on the page have been activated to begin sharing data.

System_CAPS_protmethodOnConnectionsActivating(EventArgs)

Raises the ConnectionsActivating event to indicate that a page and its controls have loaded, and the process of activating connections can begin.

System_CAPS_protmethodOnDataBinding(EventArgs)

Raises the DataBinding event.(Inherited from Control.)

System_CAPS_protmethodOnDisplayModeChanged(WebPartDisplayModeEventArgs)

Raises the DisplayModeChanged event to indicate that the WebPartManager control has completed the process of switching from one display mode to another on a Web page.

System_CAPS_protmethodOnDisplayModeChanging(WebPartDisplayModeCancelEventArgs)

Raises the DisplayModeChanging event to indicate that the WebPartManager control is in the process of switching from one display mode to another on a Web page.

System_CAPS_protmethodOnInit(EventArgs)

Raises the Init event, which is the first event in the WebPartManager control life cycle.(Overrides Control.OnInit(EventArgs).)

System_CAPS_protmethodOnLoad(EventArgs)

Raises the Load event.(Inherited from Control.)

System_CAPS_protmethodOnPreRender(EventArgs)

Raises the PreRender event, which occurs just before a WebPartManager control is rendered on a Web page. (Overrides Control.OnPreRender(EventArgs).)

System_CAPS_protmethodOnSelectedWebPartChanged(WebPartEventArgs)

Raises the SelectedWebPartChanged event, which occurs after a WebPart control has either been newly selected or had its selection cleared.

System_CAPS_protmethodOnSelectedWebPartChanging(WebPartCancelEventArgs)

Raises the SelectedWebPartChanging event, which occurs during the process of changing which WebPart control is currently selected.

System_CAPS_protmethodOnUnload(EventArgs)

Raises the base Unload event and removes the WebPartManager instance from a Web page.(Overrides Control.OnUnload(EventArgs).)

System_CAPS_protmethodOnWebPartAdded(WebPartEventArgs)

Raises the WebPartAdded event, which occurs after a WebPart control has been added to a page.

System_CAPS_protmethodOnWebPartAdding(WebPartAddingEventArgs)

Raises the WebPartAdding event, which occurs during the process of adding a WebPart control (or a server or user control) to a WebPartZoneBase zone.

System_CAPS_protmethodOnWebPartClosed(WebPartEventArgs)

Raises the WebPartClosed event to signal that a control has been removed from a page.

System_CAPS_protmethodOnWebPartClosing(WebPartCancelEventArgs)

Raises the WebPartClosing event, which occurs during the process of a WebPart or server control being removed from a page.

System_CAPS_protmethodOnWebPartDeleted(WebPartEventArgs)

Raises the WebPartDeleted event, which occurs after a WebPart control has been permanently deleted from a page.

System_CAPS_protmethodOnWebPartDeleting(WebPartCancelEventArgs)

Raises the WebPartDeleting event, which indicates that a dynamic WebPart control (or server or user control that is contained in a WebPartZoneBase zone) is in the process of being deleted.

System_CAPS_protmethodOnWebPartMoved(WebPartEventArgs)

Raises the WebPartMoved event, which occurs after a WebPart control has been moved to a different location on a page.

System_CAPS_protmethodOnWebPartMoving(WebPartMovingEventArgs)

Raises the WebPartMoving event, which indicates that a WebPart or server or user control in a WebPartZoneBase zone is in the process of being moved.

System_CAPS_protmethodOnWebPartsConnected(WebPartConnectionsEventArgs)

Raises the WebPartsConnected event, which occurs after a connection has been established between WebPart controls.

System_CAPS_protmethodOnWebPartsConnecting(WebPartConnectionsCancelEventArgs)

Raises the WebPartsConnecting event, which occurs during the process of establishing a connection between two WebPart or server or user controls contained in a WebPartZoneBase zone.

System_CAPS_protmethodOnWebPartsDisconnected(WebPartConnectionsEventArgs)

Raises the WebPartsDisconnected event, which occurs after a connection between WebPart controls has ended.

System_CAPS_protmethodOnWebPartsDisconnecting(WebPartConnectionsCancelEventArgs)

Raises the WebPartsDisconnecting event, which indicates that two WebPart or server or user controls in a WebPartZoneBase zone are in the process of ending a connection.

System_CAPS_protmethodOpenFile(String)

Gets a Stream used to read a file.(Inherited from Control.)

System_CAPS_protmethodRaiseBubbleEvent(Object, EventArgs)

Assigns any sources of the event and its information to the control's parent.(Inherited from Control.)

System_CAPS_protmethodRegisterClientScript()

Enables the WebPartManager control to emit client-side script that is used for various personalization features, such as dragging WebPart controls in a Web page.

System_CAPS_protmethodRemovedControl(Control)

Called after a child control is removed from the Controls collection of the Control object.(Inherited from Control.)

System_CAPS_protmethodRender(HtmlTextWriter)

Overridden to prevent the WebPartManager control from rendering any content.(Overrides Control.Render(HtmlTextWriter).)

System_CAPS_protmethodRenderChildren(HtmlTextWriter)

Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.(Inherited from Control.)

System_CAPS_pubmethodRenderControl(HtmlTextWriter)

Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.(Inherited from Control.)

System_CAPS_protmethodRenderControl(HtmlTextWriter, ControlAdapter)

Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.(Inherited from Control.)

System_CAPS_protmethodResolveAdapter()

Gets the control adapter responsible for rendering the specified control.(Inherited from Control.)

System_CAPS_pubmethodResolveClientUrl(String)

Gets a URL that can be used by the browser.(Inherited from Control.)

System_CAPS_pubmethodResolveUrl(String)

Converts a URL into one that is usable on the requesting client.(Inherited from Control.)

System_CAPS_protmethodSaveControlState()

Saves state data for the WebPartManager control so the data can be restored on future request to the Web page that contains the control.(Overrides Control.SaveControlState().)

System_CAPS_protmethodSaveCustomPersonalizationState(PersonalizationDictionary)

Saves custom personalization state data maintained by the WebPartManager control, so that this data can be reloaded whenever the page is reloaded.

System_CAPS_protmethodSaveViewState()

Saves any server control view-state changes that have occurred since the time the page was posted back to the server.(Inherited from Control.)

System_CAPS_protmethodSetDesignModeState(IDictionary)

Sets design-time data for a control.(Inherited from Control.)

System_CAPS_protmethodSetPersonalizationDirty()

Sets a flag indicating that custom personalization data for the WebPartManager control has changed.

System_CAPS_pubmethodSetRenderMethodDelegate(RenderMethod)

This API supports the product infrastructure and is not intended to be used directly from your code. Assigns an event handler delegate to render the server control and its content into its parent control.(Inherited from Control.)

System_CAPS_protmethodSetSelectedWebPart(WebPart)

Sets the SelectedWebPart property value equal to the currently selected WebPart or server control.

System_CAPS_pubmethodSetTraceData(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.)

System_CAPS_pubmethodSetTraceData(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.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_protmethodTrackViewState()

Applies personalization state data to the WebPartManager control, and calls the base method to enable tracking changes to the view-state data for the control.(Overrides Control.TrackViewState().)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticBrowseDisplayMode

Represents the default display mode for pages that contain Web Parts controls. This field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticCatalogDisplayMode

Represents the display mode used for adding server controls from a catalog of controls to a Web page. This field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticConnectDisplayMode

Represents the display mode used for displaying a special user interface (UI) for users to manage connections between WebPart controls. This field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticDesignDisplayMode

Represents the display mode used for changing the layout of Web pages that contain Web Parts controls. This field is read-only.

System_CAPS_pubfieldSystem_CAPS_staticEditDisplayMode

Represents the display mode in which end users can edit and modify server controls. This field is read-only.

NameDescription
System_CAPS_pubeventAuthorizeWebPart

Occurs when the IsAuthorized method is called to determine whether a WebPart or server control can be added to a page.

System_CAPS_pubeventConnectionsActivated

Occurs after all the current Web Parts connections on a page are not only connected, but have also begun actively sharing data between the consumer and provider controls involved in each connection.

System_CAPS_pubeventConnectionsActivating

Occurs during the process of activating all the established Web Parts connections on a Web page.

System_CAPS_pubeventDataBinding

Occurs when the server control binds to a data source.(Inherited from Control.)

System_CAPS_pubeventDisplayModeChanged

Occurs after the current display mode on a Web Parts page has changed.

System_CAPS_pubeventDisplayModeChanging

Occurs after a user clicks a verb on a Web page that begins the process of changing to a different display mode.

System_CAPS_pubeventDisposed

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

System_CAPS_pubeventInit

Occurs when the server control is initialized, which is the first step in its lifecycle.(Inherited from Control.)

System_CAPS_pubeventLoad

Occurs when the server control is loaded into the Page object.(Inherited from Control.)

System_CAPS_pubeventPreRender

Occurs after the Control object is loaded but prior to rendering.(Inherited from Control.)

System_CAPS_pubeventSelectedWebPartChanged

Occurs after the selection of one WebPart control has changed and moved to another control on a Web page.

System_CAPS_pubeventSelectedWebPartChanging

Occurs during the process of changing which WebPart or server control is currently selected on a Web page.

System_CAPS_pubeventUnload

Occurs when the server control is unloaded from memory.(Inherited from Control.)

System_CAPS_pubeventWebPartAdded

Occurs after a dynamic WebPart or other server control has been added to a WebPartZoneBase zone, to indicate that the control was added successfully.

System_CAPS_pubeventWebPartAdding

Occurs during the process of adding a dynamic WebPart or other server control to a WebPartZoneBase zone.

System_CAPS_pubeventWebPartClosed

Occurs when a WebPart control (or server or user control) is removed from a page.

System_CAPS_pubeventWebPartClosing

Occurs during the process of removing a WebPart control (or server or user control) from a page.

System_CAPS_pubeventWebPartDeleted

Occurs after a WebPart or other server control has been deleted from a WebPartZoneBase zone.

System_CAPS_pubeventWebPartDeleting

Occurs during the process of permanently deleting an instance of a dynamic WebPart or other server control from a WebPartZoneBase zone.

System_CAPS_pubeventWebPartMoved

Occurs after a WebPart or server control has been moved to a different location on a Web page.

System_CAPS_pubeventWebPartMoving

Occurs during the process of moving a WebPart or other server control that is contained in a WebPartZoneBase zone.

System_CAPS_pubeventWebPartsConnected

Occurs after a specific connection has been established between WebPart controls (or server or user controls).

System_CAPS_pubeventWebPartsConnecting

Occurs during the process of creating a connection between WebPart controls (or server or user controls placed in a WebPartZoneBase zone).

System_CAPS_pubeventWebPartsDisconnected

Occurs after a connection between two WebPart or server controls has been terminated.

System_CAPS_pubeventWebPartsDisconnecting

Occurs during the process of ending the connection between previously connected WebPart or server controls.

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIControlDesignerAccessor.GetDesignModeState()

For a description of this member, see IControlDesignerAccessor.GetDesignModeState.(Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIControlDesignerAccessor.SetDesignModeState(IDictionary)

For a description of this member, see IControlDesignerAccessor.SetDesignModeState. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIControlDesignerAccessor.SetOwnerControl(Control)

This API supports the product infrastructure and is not intended to be used directly from your code. For a description of this member, see IControlDesignerAccessor.SetOwnerControl. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIParserAccessor.AddParsedSubObject(Object)

For a description of this member, see IParserAccessor.AddParsedSubObject. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIPersonalizable.Load(PersonalizationDictionary)

Returns previously saved custom personalization state data that needs to be loaded to the WebPartManager control.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIPersonalizable.Save(PersonalizationDictionary)

Saves custom personalization state data that is managed by the WebPartManager control.

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIControlBuilderAccessor.ControlBuilder

For a description of this member, see IControlBuilderAccessor.ControlBuilder. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIControlDesignerAccessor.UserData

For a description of this member, see IControlDesignerAccessor.UserData. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataBindingsAccessor.DataBindings

For a description of this member, see IDataBindingsAccessor.DataBindings. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataBindingsAccessor.HasDataBindings

For a description of this member, see IDataBindingsAccessor.HasDataBindings. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIExpressionsAccessor.Expressions

For a description of this member, see IExpressionsAccessor.Expressions. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIExpressionsAccessor.HasExpressions

For a description of this member, see IExpressionsAccessor.HasExpressions. (Inherited from Control.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIPersonalizable.IsDirty

Gets a value that indicates whether custom personalization state data managed by the WebPartManager control has changed on a Web page.

NameDescription
System_CAPS_pubmethodEnableDynamicData(Type)

Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)

System_CAPS_pubmethodEnableDynamicData(Type, IDictionary<String, Object>)

Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)

System_CAPS_pubmethodEnableDynamicData(Type, Object)

Overloaded. Enables Dynamic Data behavior for the specified data control.(Defined by DataControlExtensions.)

System_CAPS_pubmethodFindDataSourceControl()

Returns the data source that is associated with the data control for the specified control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodFindFieldTemplate(String)

Returns the field template for the specified column in the specified control's naming container.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodFindMetaTable()

Returns the metatable object for the containing data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodGetDefaultValues()

Overloaded. Gets the collection of the default values for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodGetMetaTable()

Overloaded. Gets the table metadata for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodSetMetaTable(MetaTable)

Overloaded. Sets the table metadata for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodSetMetaTable(MetaTable, IDictionary<String, Object>)

Overloaded. Sets the table metadata and default value mapping for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodSetMetaTable(MetaTable, Object)

Overloaded. Sets the table metadata and default value mapping for the specified data control.(Defined by DynamicDataExtensions.)

System_CAPS_pubmethodTryGetMetaTable(MetaTable)

Overloaded. Determines whether table metadata is available.(Defined by DynamicDataExtensions.)

The WebPartManager control acts as the hub or control center of a Web Parts application. There must be one--and only one--WebPartManager control instance on every page that uses Web Parts controls. As with most aspects of Web Parts applications, the WebPartManager control works only with authenticated users. Further, its functionality works almost entirely with server controls that reside within Web Parts zones that inherit from the WebZone class. Server controls that reside on a page outside of these zones can have very little Web Parts functionality or interaction with the WebPartManager control.

As the hub for Web Parts functionality on a page, the WebPartManager control carries out the kinds of tasks described in the following table.

Task category

What the control does

Tracking Web Parts controls

Keeps track of the many different kinds of controls on a page that provide Web Parts features, including WebPart controls, connections, zones, and others.

Adding and removing Web Parts controls

Provides the methods for adding, deleting, and closing WebPart controls on a page.

Administering connections

Creates connections between controls, and monitors the connections as well as the processes of adding and removing them.

Personalizing controls and pages

Enables users to move controls to different locations on a page, and launches the views in which users can edit the appearance, properties, and behavior of controls. Maintains user-specific personalization settings on each page.

Toggling between different page views

Switches a page among different specialized views of the page, so that users can carry out certain tasks such as changing page layout or editing controls.

Raising Web Parts life-cycle events

Defines, raises, and enables developers to handle life-cycle events of Web Parts controls, such as when controls are being added, moved, connected, or deleted.

Enabling import and export of controls

Exports XML streams that contain the state of the properties of WebPart controls, and allows users to import the files for convenience in personalizing complex controls in other pages or sites.

The WebPartManager class has a large set of properties. Consistent with the WebPartManager role of tracking other controls, it has a number of properties that reference collections of either Web Parts controls, or other special Web Parts objects. The AvailableTransformers, Connections, Controls, DisplayModes, DynamicConnections, SupportedDisplayModes, WebParts, and Zones properties are all collections used by the WebPartManager control for its tracking and other management tasks.

Another group of properties contains customizable warnings that apply in certain scenarios that occur in a Web Parts application. These include the CloseProviderWarning, the DeleteWarning, and the ExportSensitiveDataWarning properties.

The WebPartManager class overrides some of its base inherited properties, which are used by many Web server controls. These include the EnableTheming, SkinID, and Visible properties.

Finally, there is a group of properties useful for accessing the current state of the application. The DisplayMode property indicates the current display mode that a page is in. The EnableClientScript property indicates whether a control is allowed to render client-side script, which is relevant in situations where users might have browsers with different capabilities or have scripting turned off. The Internals property is useful for referencing a utility class that contains the calls to a number of important Web Parts methods that are used for extensibility cases. By hiding the calls to these methods in a separate class (the WebPartManagerInternals class), the WebPartManager class's own API is simplified. The Personalization property provides access to the personalization objects that store users' personalization settings and persist that data to permanent storage. The SelectedWebPart property indicates which WebPart control on a page is currently selected by the user or the application. The IPersonalizable.IsDirty property indicates whether custom personalization data on a WebPart control has changed.

The WebPartManager control contains five built-in display modes, or views of a Web page. Developers can extend this feature, creating custom display modes by extending types such as the WebZone class or the ToolZone class. Users can switch a page into the various display modes, provided that the proper kind of controls that correspond to a given display mode are present on a page.

System_CAPS_noteNote

It is possible to extend this feature so that users can switch into a custom display mode without having a corresponding zone on the page. However, the default behavior is that display modes correspond to zones.

The standard display modes are represented by public fields in the WebPartManager class. The following table summarizes the fields and the display modes they refer to. The current display mode of a page, as noted above, is always referenced in the DisplayMode property, and the set of display modes that is possible on a particular page, given the kind of zones that are present on the page, is contained in the SupportedDisplayModes property.

Field

Display mode details

BrowseDisplayMode

The normal user view of a Web page; the default and most common display mode.

DesignDisplayMode

The view in which users can rearrange or delete controls to change the page layout.

EditDisplayMode

The view in which an editing user interface (UI) becomes visible; users can edit the appearance, properties, and behavior of the controls that are visible in the normal browse mode.

CatalogDisplayMode

The view in which a catalog UI becomes visible; users can add controls to a page from catalogs of available controls.

ConnectDisplayMode

The view in which a connection UI becomes visible; users can connect, manage, or disconnect connections between controls.

The WebPartManager control also contains a number of events that are critical in the life cycle of Web Parts pages and controls. These events provide precise programmatic control over the behavior of Web Parts controls. Most methods pertain directly to WebPart controls (or other server or user controls that are placed in WebPartZoneBase zones so that they can behave as WebPart controls). However, a few events pertain to the state of the page or connections on the page. The following table lists the available events and summarizes their purposes.

System_CAPS_noteNote

In all cases in the following table, the word "control" refers to a WebPart control or any server control that resides in a zone and is wrapped with a GenericWebPart object at run time.

Event

Description

AuthorizeWebPart

Occurs just before a control is added to a page to verify that it is authorized.

ConnectionsActivated

Occurs after all the connections on a page have been activated.

ConnectionsActivating

Occurs just before the process of activating all the connections on a page.

DisplayModeChanged

Occurs after the current display mode of a page has changed.

DisplayModeChanging

Occurs just before the process of changing a page's display mode.

SelectedWebPartChanged

Occurs after the selection of a control has been canceled.

SelectedWebPartChanging

Occurs just before the process of canceling the selection of a control.

WebPartAdded

Occurs after a control has been added to a zone.

WebPartAdding

Occurs just before the process of adding a control to a zone.

WebPartClosed

Occurs after a control has been closed (removed from a page).

WebPartClosing

Occurs just before the process of closing a control.

WebPartDeleted

Occurs after an instance of a dynamic control (one that was created programmatically or added from a catalog) has been permanently deleted.

WebPartDeleting

Occurs just before the process of deleting a dynamic control.

WebPartMoved

Occurs after a control has moved within its zone or to another zone.

WebPartMoving

Occurs just before the process of moving a control.

WebPartsConnected

Occurs after two controls selected for participation in a connection have established the connection.

WebPartsConnecting

Occurs just before the process of connecting two controls.

WebPartsDisconnected

Occurs after two connected controls have been disconnected.

WebPartsDisconnecting

Occurs just before the process of disconnecting two controls.

The WebPartManager control has numerous methods for managing Web Parts pages. A large set of the methods, not listed here, are methods whose names take the form of OnEventName. These methods typically raise their associated event, and provide the event with a handler of type WebPartEventHandler. Most of these methods can be overridden by developers who inherit from the WebPartManager class. Also, page developers can provide custom handlers for the events associated with these methods. For example, in the case of the WebPartAdded event, a page developer could add an OnWebPartAdded attribute to the <asp:webpartmanager> element in the markup of a Web page, and then assign a custom method name to the attribute to provide custom handling for the event. The attribute corresponds to the OnWebPartAdded method, and this basic pattern of event handling works for most Web Parts events and their associated methods.

In addition, the WebPartManager control has methods particular to the task of managing WebPart controls (and server or user controls used as WebPart controls). These methods include AddWebPart, AuthorizeWebPart, CloseWebPart, CopyWebPart, CreateWebPart, DeleteWebPart, DisconnectWebPart, BeginWebPartEditing, EndWebPartEditing, ExportWebPart, GetGenericWebPart, ImportWebPart, IsAuthorized, and MoveWebPart.

Another set of methods is specialized for connections. This includes methods such as ActivateConnections, BeginWebPartConnecting, CanConnectWebParts, ConnectWebParts, CreateAvailableTransformers, DisconnectWebPart, DisconnectWebParts, EndWebPartConnecting, GetConsumerConnectionPoints, and GetProviderConnectionPoints.

Finally, some WebPartManager methods focus on personalization functionality. These include CreatePersonalization, LoadControlState, SaveCustomPersonalizationState, SetPersonalizationDirty, IPersonalizable.Load, IPersonalizable.Save, and SaveControlState.

For more information on other WebPartManager methods that are accessible through the Internals property, see the documentation for the WebPartManagerInternals class.

Notes to Inheritors:

The WebPartManager control is designed to be extended. Because it is so central to Web Parts applications, when you want to extend some specific type or control in the Web Parts control set, in many cases you must also extend the WebPartManager class, because it is likely to have some property or method that is required to make your custom type work in the context of a Web Parts application. The Web Parts reference documentation (see System.Web.UI.WebControls.WebParts), when discussing how to extend a Web Parts type, frequently mentions what needs to be done to extend the WebPartManager class as well, or shows how to extend it in a code example.

The following code example demonstrates both declarative and programmatic use of the WebPartManager control.

The code example has four parts:

  • A user control that enables you to change display modes on a Web Parts page.

  • A Web page that contains two custom WebPart controls that can be connected, and an <asp:webpartmanager> element.

  • A source code file that contains two custom WebPart controls, and a custom interface.

  • An explanation of how the example works in a browser.

The user control has a drop-down list control that shows the possible display modes on a page, given the Web Parts controls that are present on the page. In the Web page for this code example, this user control is declared just below the WebPartManager element in the page's markup, and there is a Register directive near the top of the Web page to register the control. For details about display modes and a description of the source 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 declarative markup for the Web page contains Register directives for both the user control and the custom controls. There is an <asp:webpartmanager> element, an <asp:webpartzone> element to contain the custom controls, and an <asp:connectionszone> element. The page also contains some inline code that handles connection-related events for the WebPartManager control; you can see the effect of this code as you connect and disconnect controls.

<%@ Page Language="C#" %>
<%@ register TagPrefix="uc1" 
  TagName="DisplayModeMenuCS" 
  Src="DisplayModeMenuCS.ascx" %>
<%@ register tagprefix="aspSample" 
  Namespace="Samples.AspNet.CS.Controls" 
  Assembly="ConnectionSampleCS" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  private void UpdateLabelData(int wpCount, int connCount)
  {
    Label1.Text = "WebPart Control Count:  " + wpCount.ToString();
    Label2.Text = "Connections Count: " + connCount.ToString();
  }

  protected void WebPartManager1_WebPartsConnected(object sender, WebPartConnectionsEventArgs e)
  {
    UpdateLabelData(WebPartManager1.WebParts.Count,
      WebPartManager1.Connections.Count);
  }

  protected void WebPartManager1_WebPartsDisconnected(object sender, WebPartConnectionsEventArgs e)
  {
    UpdateLabelData(WebPartManager1.WebParts.Count,
      WebPartManager1.Connections.Count);
  }

</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
      <!-- Reference the WebPartManager control. -->
      <asp:WebPartManager ID="WebPartManager1" runat="server"  
        OnWebPartsConnected="WebPartManager1_WebPartsConnected" 
        OnWebPartsDisconnected="WebPartManager1_WebPartsDisconnected" />
    <div>
      <uc1:DisplayModeMenuCS ID="displaymode1" runat="server" />
      <!-- Reference consumer and provider controls in a zone. -->
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <aspSample:ZipCodeWebPart ID="zip1" 
            runat="server" 
            Title="Zip Code Control"/>
          <aspSample:WeatherWebPart ID="weather1" 
            runat="server" 
            Title="Weather Control" />
        </ZoneTemplate>
      </asp:WebPartZone>
      <hr />
      <asp:Label ID="Label1" runat="server" Text=""></asp:Label>
      <br />
      <asp:Label ID="Label2" runat="server" Text=""></asp:Label>
      <!-- Add a ConnectionsZone so users can connect controls. -->
      <asp:ConnectionsZone ID="ConnectionsZone1" runat="server" />
    </div>
    </form>
</body>
</html>

The third part of the example is the source code for the controls. Note that there is an interface named IZipCode, and this interface is implemented in the ZipCodeWebPart class. This class has a special callback method named ProvideIZipCode that serves as a provider. The other type, named WeatherWebPart, is also implemented with a special method named GetIZipCode, which enables the control to act as a consumer of the other control.

For the code example to run, you must compile this source code. You can compile it explicitly and put the resulting assembly in your Web site's Bin folder or the global assembly cache. Alternatively, you can put the source code in your site's App_Code folder, where it will be dynamically compiled at run time. This code example assumes that you have compiled the source into an assembly, and the Register directive in the Web page references the assembly name. For a walkthrough that demonstrates how to compile, see Walkthrough: Developing and Using a Custom Web Server Control.

namespace Samples.AspNet.CS.Controls
{
  using System;
  using System.Web;
  using System.Web.Security;
  using System.Security.Permissions;
  using System.Web.UI;
  using System.Web.UI.WebControls;
  using System.Web.UI.WebControls.WebParts;

  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public interface IZipCode
  {
    string ZipCode { get; set;}
  }

  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public class ZipCodeWebPart : WebPart, IZipCode
  {
    string zipCodeText = String.Empty;
    TextBox input;
    Button send;

    public ZipCodeWebPart()
    {
    }

    // Make the implemented property personalizable to save 
    // the Zip Code between browser sessions.
    [Personalizable()]
    public virtual string ZipCode
    {
      get { return zipCodeText; }
      set { zipCodeText = value; }
    }

    // This is the callback method that returns the provider.
    [ConnectionProvider("Zip Code")]
    public IZipCode ProvideIZipCode()
    {
      return this;
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();
      input = new TextBox();
      this.Controls.Add(input);
      send = new Button();
      send.Text = "Enter 5-digit Zip Code";
      send.Click += new EventHandler(this.submit_Click);
      this.Controls.Add(send);
    }

    private void submit_Click(object sender, EventArgs e)
    {
      if (input.Text != String.Empty)
      {
        zipCodeText = Page.Server.HtmlEncode(input.Text);
        input.Text = String.Empty;
      }
    }

  }

  [AspNetHostingPermission(SecurityAction.Demand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand,
    Level = AspNetHostingPermissionLevel.Minimal)]
  public class WeatherWebPart : WebPart
  {
    private IZipCode _provider;
    string _zipSearch;
    Label DisplayContent;

    // This method is identified by the ConnectionConsumer 
    // attribute, and is the mechanism for connecting with 
    // the provider. 
    [ConnectionConsumer("Zip Code")]
    public void GetIZipCode(IZipCode Provider)
    {
      _provider = Provider;
    }

    protected override void OnPreRender(EventArgs e)
    {
      EnsureChildControls();

      if (this._provider != null)
      {
        _zipSearch = _provider.ZipCode.Trim();
        DisplayContent.Text = "My Zip Code is:  " + _zipSearch;
      }
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();
      DisplayContent = new Label();
      this.Controls.Add(DisplayContent);
    }

  }
}

After you have loaded the Web page in a browser, click the Display Mode drop-down list control and select Connect to switch the page to connect mode. Connect mode uses the <asp:connectionszone> element to enable you to create connections between controls. In connect mode, click the downward arrow in the title bar of the ZIP Code control to activate its verbs menu, and then click Connect. After the connection UI appears, click the Create a connection to a Consumer link. A cell appears that has a drop-down list control. Select Weather Control in the drop-down list, and then click Connect to complete the connection of the two controls. Click Close, and then use the Display Mode drop-down list to return the page to normal browse mode. You can enter a ZIP Code, and the consumer control will be updated with the value you enter. Because the ZipCode property was marked with the Personalizable attribute in the source code, this property value will persist across browser sessions, thus saving the value entered by a user. A more sophisticated consumer control could take the ZIP code information, look up weather information based on the code, and display it to a user.

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: