This documentation is archived and is not being maintained.
WebPartManager Methods
Visual Studio 2008
The WebPartManager type exposes the following members.
| 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.) |
|
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. |
|
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.) |
|
CanConnectWebParts | Overloaded. Checks the WebPart controls that will be participating in a connection to determine whether they are capable of being connected. |
|
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.) |
|
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. |
|
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 | 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().) |
|
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. |
|
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. |
|
DataBindChildren | Binds a data source to the server control's child controls. (Inherited from Control.) |
|
DeleteWebPart | Permanently removes a dynamic instance of a WebPart control from a Web page. |
|
DisconnectWebPart | Removes a WebPart or server control that is being closed or deleted from any connections it is participating in. |
|
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. |
|
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.) |
|
ExportWebPart | Creates an XML description file that contains state and property data for a server control. |
|
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 | Overridden to prevent focus from ever being set on the WebPartManager control, because it has no user interface (UI). (Overrides Control::Focus().) |
|
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. |
|
GetDesignModeState | Infrastructure. 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. |
|
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.) |
|
HasEvents | Returns a value indicating whether events are registered for the control or 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. |
|
IsLiteralContent | Infrastructure. Determines if the server control holds only literal content. (Inherited from Control.) |
|
LoadControlState | 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).) |
|
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.) |
|
MoveWebPart | Moves a WebPart or server control from one WebPartZoneBase zone to another, or to a new position within the same zone. |
|
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 | Raises the Init event, which is the first event in the WebPartManager control life cycle. (Overrides Control::OnInit(EventArgs).) |
|
OnLoad | Raises the Load event. (Inherited from Control.) |
|
OnPreRender | Raises the PreRender event, which occurs just before a WebPartManager control is rendered on a Web page. (Overrides Control::OnPreRender(EventArgs).) |
|
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 | Raises the base Unload event and removes the WebPartManager instance from a Web page. (Overrides Control::OnUnload(EventArgs).) |
|
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 to prevent the WebPartManager control from rendering any content. (Overrides Control::Render(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.) |
|
RenderControl | Overloaded. Outputs server control content and stores tracing information about the control if tracing is enabled. |
|
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.) |
|
SaveControlState | 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().) |
|
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. |
|
SetRenderMethodDelegate | Infrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.) |
|
SetSelectedWebPart | Sets the SelectedWebPart property value equal to the currently selected WebPart or server control. |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
TrackViewState | 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().) |
| 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 | |
|---|---|---|
|
IParserAccessor::AddParsedSubObject | For a description of this member, see IParserAccessor::AddParsedSubObject. (Inherited from Control.) |
|
IControlDesignerAccessor::GetDesignModeState | For a description of this member, see IControlDesignerAccessor::GetDesignModeState. (Inherited from Control.) |
|
IPersonalizable::Load | Returns previously saved custom personalization state data that needs to be loaded to the WebPartManager control. |
|
IPersonalizable::Save | Saves custom personalization state data that is managed by the WebPartManager control. |
|
IControlDesignerAccessor::SetDesignModeState | For a description of this member, see IControlDesignerAccessor::SetDesignModeState. (Inherited from Control.) |
|
IControlDesignerAccessor::SetOwnerControl | Infrastructure. For a description of this member, see IControlDesignerAccessor::SetOwnerControl. (Inherited from Control.) |
Show: