WebPartManager Members
.NET Framework 3.0
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.
The following tables list the members exposed by the WebPartManager type.
| Name | Description | |
|---|---|---|
| BrowseDisplayMode | Represents the default display mode for pages that contain Web Parts controls. This field is read-only. |
| CatalogDisplayMode | Represents the display mode used for adding server controls from a catalog of controls to a Web page. This field is read-only. |
| ConnectDisplayMode | 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. |
| DesignDisplayMode | Represents the display mode used for changing the layout of Web pages that contain Web Parts controls. This field is read-only. |
| EditDisplayMode | Represents the display mode in which end users can edit and modify server controls. This field is read-only. |
(see also
Protected Properties
)
Top
| Name | Description | |
|---|---|---|
| AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.(inherited from Control) |
| AvailableTransformers | Gets a collection of WebPartTransformer objects that are available for use in creating Web Parts connections between server controls. |
| BindingContainer | Gets the control that contains this control's data binding.(inherited from Control) |
| ClientID | Gets the server control identifier generated by ASP.NET.(inherited from Control) |
| CloseProviderWarning | 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. |
| Connections | Gets a reference to the collection of all current connections on a Web page. |
| Controls | 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. |
| DeleteWarning | Gets or sets a custom warning message displayed to end users when they delete a control. |
| DisplayMode | Gets or sets the active display mode for a Web page that contains Web Parts controls. |
| DisplayModes | Gets a read-only collection of all display modes that are associated with a WebPartManager control. |
| EnableClientScript | Gets or sets a value that determines whether client-side scripting is enabled on the Web page that contains a WebPartManager control. |
| EnableTheming | Gets a value indicating that the use of themes is enabled on a Web page. |
| 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) |
| ExportSensitiveDataWarning | 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. |
| ID | Gets or sets the programmatic identifier assigned to the server control.(inherited from Control) |
| NamingContainer | Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same Control.ID property value.(inherited from Control) |
| 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) |
| Personalization | Gets a reference to an object that contains personalization data for a Web page. |
| SelectedWebPart | Gets a reference to a WebPart or other server control that is currently selected for editing or for creating a connection with another control. |
| Site | Gets information about the container that hosts the current control when rendered on a design surface.(inherited from Control) |
| SkinID | Gets or sets an empty string ("") so that no skin can be applied to the WebPartManager control. |
| StaticConnections | Gets a reference to the collection of all WebPartConnection objects on a Web page that are defined as static connections. |
| SupportedDisplayModes | Gets a read-only collection of all display modes that are available on a particular Web page. |
| 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) |
| UniqueID | Gets the unique, hierarchically qualified identifier for the server control.(inherited from Control) |
| Visible | Gets a value that enables child controls to be visible. |
| WebParts | Gets a reference to all WebPart controls tracked by the WebPartManager control on a Web page. |
| Zones | Gets a reference to a collection of all the WebPartZoneBase zones on a Web page. |
| Name | Description | |
|---|---|---|
| Adapter | Gets the browser-specific adapter for the control.(inherited from Control) |
| ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created.(inherited from Control) |
| ClientIDSeparator | Gets a character value representing the separator character used in the ClientID property.(inherited from Control) |
| Context | Gets the HttpContext object associated with the server control for the current Web request.(inherited from Control) |
| DesignMode | Gets a value indicating whether a control is being used on a design surface.(inherited from Control) |
| DynamicConnections | Gets the collection of all dynamic connections that currently exist on a Web page. |
| Events | Gets a list of event handler delegates for the control. This property is read-only.(inherited from Control) |
| HasChildViewState | Gets a value indicating whether the current server control's child controls have any saved view-state settings.(inherited from Control) |
| IdSeparator | Gets the character used to separate control identifiers.(inherited from Control) |
| Internals | 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. |
| IsChildControlStateCleared | Gets a value indicating whether controls contained within this control have control state.(inherited from Control) |
| IsCustomPersonalizationStateDirty | Gets a value that indicates whether personalization changes have been made that affect page-level personalization details controlled by the WebPartManager control. |
| IsTrackingViewState | Gets a value that indicates whether the server control is saving changes to its view state.(inherited from Control) |
| IsViewStateEnabled | Gets a value indicating whether view state is enabled for this control.(inherited from Control) |
| LoadViewStateByID | Gets a value indicating whether the control participates in loading its view state by ID instead of index. (inherited from Control) |
| 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) |
(see also
Protected Methods
)
Top
| Name | Description | |
|---|---|---|
| AddWebPart | Provides the standard programmatic method for adding WebPart controls to a Web page. |
| ApplyStyleSheetSkin | Applies the style properties defined in the page style sheet to the control. (inherited from Control) |
| BeginWebPartConnecting | Starts the process of connecting two WebPart controls. |
| BeginWebPartEditing | Starts the process of editing a WebPart control. |
| CanConnectWebParts | Overloaded. Checks the WebPart controls that will be participating in a connection to determine whether they are capable of being connected. |
| CloseWebPart | Closes a WebPart control in such a way that it is not rendered on a Web page, but can be reopened. |
| ConnectWebParts | Overloaded. Creates a connection between two WebPart controls (or other server controls capable of forming connections) that reside in a WebPartZoneBase zone. |
| CreateWebPart | Wraps a server control that is not a WebPart control with a GenericWebPart object, so that the control can have Web Parts functionality. |
| DataBind | Overloaded. Binds a data source to the invoked server control and all its child controls. (inherited from Control) |
| DeleteWebPart | Permanently removes a dynamic instance of a WebPart control from a Web page. |
| DisconnectWebParts | Carries out the process of disconnecting server controls that are connected on a Web page. |
| Dispose | Enables a server control to perform final clean up before it is released from memory. (inherited from Control) |
| EndWebPartConnecting | Completes the process of connecting a WebPart control to another control. |
| EndWebPartEditing | Completes the process of editing a WebPart control. |
| Equals | Overloaded. Determines whether two Object instances are equal. (inherited from Object) |
| ExportWebPart | Creates an XML description file that contains state and property data for a server control. |
| FindControl | Overloaded. Searches the current naming container for the specified server control. (inherited from Control) |
| Focus | Overridden. Overridden to prevent focus from ever being set on the WebPartManager control, because it has no user interface (UI). |
| GetConsumerConnectionPoints | 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. |
| GetCurrentWebPartManager | Retrieves a reference to the current instance of the WebPartManager control on a page. |
| GetExportUrl | Gets the relative virtual path and the query string that are part of the request when a user attempts to export a WebPart control. |
| GetGenericWebPart | Gets a reference to the instance of the GenericWebPart control that contains a server control. |
| GetHashCode | Serves as a hash function for a particular type. (inherited from Object) |
| GetProviderConnectionPoints | 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. |
| GetType | Gets the Type of the current instance. (inherited from Object) |
| HasControls | Determines if the server control contains any child controls. (inherited from Control) |
| ImportWebPart | Imports an XML description file that contains state and property data for a WebPart control, and applies the data to the control. |
| IsAuthorized | Overloaded. Determines whether a WebPart or other server control can be added to a page. |
| MoveWebPart | Moves a WebPart or server control from one WebPartZoneBase zone to another, or to a new position within the same zone. |
| ReferenceEquals | Determines whether the specified Object instances are the same instance. (inherited from Object) |
| RenderControl | Overloaded. Outputs server control content and stores tracing information about the control if tracing is enabled. (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) |
| SetRenderMethodDelegate | 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) |
| Name | Description | |
|---|---|---|
| ActivateConnections | Makes active all connections on a Web page that are currently inactive. |
| 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) |
| BuildProfileTree | 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) |
| CheckRenderClientScript | Checks the capabilities of the browser making the request, and the value of the EnableClientScript property, to determine whether to render client script. |
| 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) |
| CopyWebPart | 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. |
| CreateAvailableTransformers | 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. |
| CreateChildControls | Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (inherited from Control) |
| CreateControlCollection | Overridden. Returns the collection of all controls that are managed by the WebPartManager control on a Web page. This class cannot be inherited. |
| CreateDisplayModes | Creates the set of all possible display modes for a Web Parts application. |
| CreateDynamicConnectionID | Gets a unique value to serve as an ID for a dynamic connection. |
| CreateDynamicWebPartID | Generates a unique ID for a dynamic WebPart control. |
| CreateErrorWebPart | 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. |
| CreatePersonalization | Returns a personalization object to contain a user's personalization data for the current Web page. |
| DataBind | Overloaded. Binds a data source to the invoked server control and all its child controls. (inherited from Control) |
| DataBindChildren | Binds a data source to the server control's child controls. (inherited from Control) |
| DisconnectWebPart | Removes a WebPart or server control that is being closed or deleted from any connections it is participating in. |
| 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) |
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (inherited from Object) |
| FindControl | Overloaded. Searches the current naming container for the specified server control. (inherited from Control) |
| GetDesignModeState | Gets design-time data for a control. (inherited from Control) |
| GetDisplayTitle | Gets a string containing the value for the DisplayTitle property of a WebPart control. |
| HasEvents | Returns a value indicating whether events are registered for the control or any child controls. (inherited from Control) |
| IsLiteralContent | Determines if the server control holds only literal content. (inherited from Control) |
| LoadControlState | Overridden. Loads control state data that was saved from a previous page request, and needs to be restored on a subsequent request. |
| LoadCustomPersonalizationState | 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. |
| LoadViewState | Restores view-state information from a previous page request that was saved by the SaveViewState method. (inherited from Control) |
| 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) |
| OnAuthorizeWebPart | Raises the AuthorizeWebPart event and invokes a handler for the event, if one exists. |
| OnBubbleEvent | Determines whether the event for the server control is passed up the page's UI server control hierarchy. (inherited from Control) |
| OnConnectionsActivated | 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. |
| OnConnectionsActivating | Raises the ConnectionsActivating event to indicate that a page and its controls have loaded, and the process of activating connections can begin. |
| OnDataBinding | Raises the DataBinding event. (inherited from Control) |
| OnDisplayModeChanged | 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. |
| OnDisplayModeChanging | 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. |
| OnInit | Overridden. Raises the Init event, which is the first event in the WebPartManager control life cycle. |
| OnLoad | Raises the Load event. (inherited from Control) |
| OnPreRender | Overridden. Raises the PreRender event, which occurs just before a WebPartManager control is rendered on a Web page. |
| OnSelectedWebPartChanged | Raises the SelectedWebPartChanged event, which occurs after a WebPart control has either been newly selected or had its selection cleared. |
| OnSelectedWebPartChanging | Raises the SelectedWebPartChanging event, which occurs during the process of changing which WebPart control is currently selected. |
| OnUnload | Overridden. Raises the base Unload event and removes the WebPartManager instance from a Web page. |
| OnWebPartAdded | Raises the WebPartAdded event, which occurs after a WebPart control has been added to a page. |
| OnWebPartAdding | Raises the WebPartAdding event, which occurs during the process of adding a WebPart control (or a server or user control) to a WebPartZoneBase zone. |
| OnWebPartClosed | Raises the WebPartClosed event to signal that a control has been removed from a page. |
| OnWebPartClosing | Raises the WebPartClosing event, which occurs during the process of a WebPart or server control being removed from a page. |
| OnWebPartDeleted | Raises the WebPartDeleted event, which occurs after a WebPart control has been permanently deleted from a page. |
| OnWebPartDeleting | 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. |
| OnWebPartMoved | Raises the WebPartMoved event, which occurs after a WebPart control has been moved to a different location on a page. |
| OnWebPartMoving | 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. |
| OnWebPartsConnected | Raises the WebPartsConnected event, which occurs after a connection has been established between WebPart controls. |
| OnWebPartsConnecting | 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. |
| OnWebPartsDisconnected | Raises the WebPartsDisconnected event, which occurs after a connection between WebPart controls has ended. |
| OnWebPartsDisconnecting | 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. |
| 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) |
| RegisterClientScript | 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. |
| RemovedControl | Called after a child control is removed from the Controls collection of the Control object. (inherited from Control) |
| Render | Overridden. Overridden to prevent the WebPartManager control from rendering any content. |
| 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) |
| RenderControl | Overloaded. Outputs server control content and stores tracing information about the control if tracing is enabled. (inherited from Control) |
| ResolveAdapter | Gets the control adapter responsible for rendering the specified control. (inherited from Control) |
| SaveControlState | Overridden. Saves state data for the WebPartManager control so the data can be restored on future request to the Web page that contains the control. |
| SaveCustomPersonalizationState | Saves custom personalization state data maintained by the WebPartManager control, so that this data can be reloaded whenever the page is reloaded. |
| SaveViewState | Saves any server control view-state changes that have occurred since the time the page was posted back to the server. (inherited from Control) |
| SetDesignModeState | Sets design-time data for a control. (inherited from Control) |
| SetPersonalizationDirty | Sets a flag indicating that custom personalization data for the WebPartManager control has changed. |
| SetSelectedWebPart | Sets the SelectedWebPart property value equal to the currently selected WebPart or server control. |
| TrackViewState | Overridden. 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. |
| Name | Description | |
|---|---|---|
| AuthorizeWebPart | Occurs when the IsAuthorized method is called to determine whether a WebPart or server control can be added to a page. |
| ConnectionsActivated | 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. |
| ConnectionsActivating | Occurs during the process of activating all the established Web Parts connections on a Web page. |
| DataBinding | Occurs when the server control binds to a data source.(inherited from Control) |
| DisplayModeChanged | Occurs after the current display mode on a Web Parts page has changed. |
| DisplayModeChanging | Occurs after a user clicks a verb on a Web page that begins the process of changing to a different display mode. |
| 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) |
| SelectedWebPartChanged | Occurs after the selection of one WebPart control has changed and moved to another control on a Web page. |
| SelectedWebPartChanging | Occurs during the process of changing which WebPart or server control is currently selected on a Web page. |
| Unload | Occurs when the server control is unloaded from memory.(inherited from Control) |
| WebPartAdded | Occurs after a dynamic WebPart or other server control has been added to a WebPartZoneBase zone, to indicate that the control was added successfully. |
| WebPartAdding | Occurs during the process of adding a dynamic WebPart or other server control to a WebPartZoneBase zone. |
| WebPartClosed | Occurs when a WebPart control (or server or user control) is removed from a page. |
| WebPartClosing | Occurs during the process of removing a WebPart control (or server or user control) from a page. |
| WebPartDeleted | Occurs after a WebPart or other server control has been deleted from a WebPartZoneBase zone. |
| WebPartDeleting | Occurs during the process of permanently deleting an instance of a dynamic WebPart or other server control from a WebPartZoneBase zone. |
| WebPartMoved | Occurs after a WebPart or server control has been moved to a different location on a Web page. |
| WebPartMoving | Occurs during the process of moving a WebPart or other server control that is contained in a WebPartZoneBase zone. |
| WebPartsConnected | Occurs after a specific connection has been established between WebPart controls (or server or user controls). |
| WebPartsConnecting | Occurs during the process of creating a connection between WebPart controls (or server or user controls placed in a WebPartZoneBase zone). |
| WebPartsDisconnected | Occurs after a connection between two WebPart or server controls has been terminated. |
| WebPartsDisconnecting | Occurs during the process of ending the connection between previously connected WebPart or server controls. |
Reference
WebPartManager ClassSystem.Web.UI.WebControls.WebParts Namespace
WebPartManagerInternals
Other Resources
ASP.NET Web Parts PagesCommunity Additions
ADD
Show: