WebPart methods
SharePoint 2013
The WebPart type exposes the following members.
| Name | Description | |
|---|---|---|
|
AddAttributesToRender | (Inherited from Panel.) |
|
|
AddedControl | (Inherited from Control.) |
|
|
AddParsedSubObject | Used to process Web Part XML for static Web Parts. (Overrides Control.AddParsedSubObject(Object).) |
|
AfterDeserialize | Called after a SharePoint Web Part's properties are deserialized from the SharePoint database or from a Web Part description file (.dwp). Suggested place for SharePoint Web Part upgrade code. |
|
|
ApplyStyle | (Inherited from WebControl.) |
|
|
ApplyStyleSheetSkin | (Inherited from Control.) |
|
|
BuildProfileTree | (Inherited from Control.) |
|
|
CanRunAt | Obsolete. Returns a value that indicates where the implementation of a connection interface can run. |
|
|
ClearCachedClientID | (Inherited from Control.) |
|
|
ClearChildControlState | (Inherited from Control.) |
|
|
ClearChildState | (Inherited from Control.) |
|
|
ClearChildViewState | (Inherited from Control.) |
|
|
ClearEffectiveClientIDMode | (Inherited from Control.) |
|
|
CopyBaseAttributes | (Inherited from WebControl.) |
|
|
CreateChildControls | (Inherited from Control.) |
|
|
CreateControlCollection | (Inherited from Control.) |
|
|
CreateControlStyle | (Inherited from Panel.) |
|
|
CreateEditorParts | (Inherited from WebPart.) |
|
|
CreateWebPartMenu | Called after the Microsoft ASP.NET Load event and used to modify or override the default menu. |
|
|
DataBind() | (Inherited from Part.) |
|
|
DataBind(Boolean) | (Inherited from Control.) |
|
|
DataBindChildren | (Inherited from Control.) |
|
|
Dispose | Releases all resources used by the Web Part. (Overrides Control.Dispose().) |
|
|
EnsureChildControls | (Inherited from Control.) |
|
|
EnsureID | (Inherited from Control.) |
|
|
EnsureInterfaces | Obsolete. Provides notification for a connectable Web Part that it should ensure all its interfaces are registered using the RegisterInterface method. |
|
|
Equals | (Inherited from Object.) |
|
|
Finalize | (Inherited from Object.) |
|
|
FindControl(String) | (Inherited from Control.) |
|
|
FindControl(String, Int32) | (Inherited from Control.) |
|
|
Focus | (Inherited from Control.) |
|
|
GetCustomBuilder | Provides the ability to associate a dynamic builder with a custom property of a Web Part. |
|
|
GetData | Obsolete. Called when the System.Web.UI.Control.PreRender event occurs to allow a Web Part to retrieve data. |
|
|
GetDesignModeState | (Inherited from Control.) |
|
|
GetDesignTimeFooter | Returns the static HTML for the footer portion of a Web Part frame to a custom designer created by deriving from System.Web.UI.ControlDesigner. |
|
|
GetDesignTimeHeader | Returns static HTML for the header portion of a Web Part frame to a custom designer created by deriving from System.Web.UI.ControlDesigner. |
|
|
GetHashCode | (Inherited from Object.) |
|
|
GetInitEventArgs | Obsolete. Returns the InitEventArgs object for the name of the interface that is passed in. |
|
|
GetRequiresData | Obsolete. The virtual method that is called by the Web Part infrastructure when the System.Web.UI.Control.PreRender event occurs to indicate that a Web Part requires data. |
|
|
GetRouteUrl(Object) | (Inherited from Control.) |
|
|
GetRouteUrl(RouteValueDictionary) | (Inherited from Control.) |
|
|
GetRouteUrl(String, Object) | (Inherited from Control.) |
|
|
GetRouteUrl(String, RouteValueDictionary) | (Inherited from Control.) |
|
|
GetThemedImages | Returns the list of themed images which this webpart uses in CSR, possibly null |
|
|
GetThemedLocalizedImages | Returns the list of localized themed images which this webpart uses in CSR, possibly null |
|
|
GetToolParts | Determines which tool parts are displayed in the tool pane of the Web-based Web Part design user interface, and the order in which they are displayed. |
|
|
GetType | (Inherited from Object.) |
|
|
GetUniqueIDRelativeTo | (Inherited from Control.) |
|
|
HasControls | (Inherited from Control.) |
|
|
HasEvents | (Inherited from Control.) |
|
|
IsLiteralContent | (Inherited from Control.) |
|
|
LoadControlState | (Inherited from Control.) |
|
|
LoadResource | Returns a string that describes the localized name, category, and description of the specified resource. |
|
|
LoadViewState | Restores view-state information from a previous request that was saved with the SaveViewState() method. (Overrides WebControl.LoadViewState(Object).) |
|
|
MapPathSecure | (Inherited from Control.) |
|
|
MemberwiseClone | (Inherited from Object.) |
|
|
MergeStyle | (Inherited from WebControl.) |
|
|
NotifyWorkItemComplete | Obsolete. Indicates that work being performed on an external asynchronous thread that has been registered using the RegisterWorkItem method has completed. |
|
|
OnBubbleEvent | (Inherited from Control.) |
|
|
OnClosing | (Inherited from WebPart.) |
|
|
OnConnectModeChanged | (Inherited from WebPart.) |
|
|
OnDataBinding | The event handler for the System.Web.UI.Control.DataBinding event that occurs when a Web Part is binding to a data source. (Overrides Control.OnDataBinding(EventArgs).) |
|
|
OnDeleting | (Inherited from WebPart.) |
|
|
OnEditModeChanged | (Inherited from WebPart.) |
|
|
OnInit | The event handler for the System.Web.UI.Control.Init event that occurs as the Web Part is being instantiated. (Overrides Control.OnInit(EventArgs).) |
|
|
OnLoad | (Inherited from Control.) |
|
|
OnPreRender | The event handler for the System.Web.UI.Control.PreRender event that occurs immediately before the Web Part is rendered to its containing Web Part Page. (Overrides Control.OnPreRender(EventArgs).) |
|
|
OnUnload | The event handler for the System.Web.UI.Control.Unload event, which occurs when the Web Part is being unloaded from memory. (Overrides Control.OnUnload(EventArgs).) |
|
|
OpenFile | (Inherited from Control.) |
|
|
PartCacheInvalidate() | Marks all the contents of the Web Part cache as outdated. |
|
|
PartCacheInvalidate(Storage) | Marks all contents of the specified storage type in the Web Part cache as outdated. |
|
|
PartCacheInvalidate(Storage, String) | Marks the specified cache entries of the specified storage type in the Web Part cache as outdated. |
|
|
PartCacheRead | Reads and returns a value from the specified location in the specified type of storage in the Web Part cache. |
|
|
PartCacheWrite | Stores the specified value of the specified type of storage in the Web Part cache. |
|
|
PartCommunicationConnect | Obsolete. Used to notify a Web Part that it has been connected to another Web Part. |
|
|
PartCommunicationInit | Obsolete. Provides a connectable Web Part with a method for firing any of its initialization events, such as the CellProviderInit or CellConsumerInit event. |
|
|
PartCommunicationMain | Obsolete. Provides a connectable Web Part with a method to fire events for any of the main events of a connectable Web Part, such as the CellReady event. |
|
|
RaiseBubbleEvent | (Inherited from Control.) |
|
|
RegisterInterface(String, String, Int32, ConnectionRunAt, Object, String, String, String) | Obsolete. Registers an interface from the Microsoft.SharePoint.WebPartPages.Communication namespace for a connectable Web Part. |
|
|
RegisterInterface(String, String, Int32, ConnectionRunAt, Object, String, String, String, Boolean) | Obsolete. Registers an interface from the Microsoft.SharePoint.WebPartPages.Communication namespace for a connectable Web Part with the option of specifying how cross-page connections are handled. |
|
|
RegisterWorkItem | Obsolete. Keeps track of work being done by an external thread, such as a Web Part that handles its own thread pool. |
|
|
RegisterWorkItemCallback | Obsolete. Queues a Web Part work item to the thread pool, invokes the specified delegate, and specifies an object to be passed to the delegate when serviced from the thread pool. |
|
|
RemovedControl | (Inherited from Control.) |
|
|
Render | Renders the control to the specified HTML writer. This method is inherited from the System.Web.UI.Control class. (Overrides WebControl.Render(HtmlTextWriter).) |
|
|
RenderBeginTag | (Inherited from Panel.) |
|
|
RenderChildren | (Inherited from Control.) |
|
|
RenderContents | (Inherited from WebControl.) |
|
|
RenderControl(HtmlTextWriter) | (Inherited from Control.) |
|
|
RenderControl(HtmlTextWriter, ControlAdapter) | (Inherited from Control.) |
|
|
RenderEndTag | (Inherited from Panel.) |
|
|
RenderWebPart | Renders the HTML for the body of a Web Part to the client. |
|
|
RenderWorkItemTimeout | Obsolete. Renders HTML in a Web Part when a work item has timed out. |
|
|
ReplaceTokens | Performs token replacement for a string, using the same algorithm used for URL-valued properties. |
|
|
RequiresWebPartClientScript | Indicates whether this Web Part has client-side script to register with the Web Part Page Services Component (WPSC) framework. |
|
|
ResolveAdapter | (Inherited from Control.) |
|
|
ResolveClientUrl | (Inherited from Control.) |
|
|
ResolveUrl | (Inherited from Control.) |
|
|
SaveControlState | (Inherited from Control.) |
|
|
SaveViewState | (Inherited from WebControl.) |
|
|
SetDesignModeState | (Inherited from Control.) |
|
|
SetPersonalizationDirty | (Inherited from WebPart.) |
|
|
SetRenderMethodDelegate | (Inherited from Control.) |
|
|
SetWebPartPageComponent | |
|
|
ShouldSerializeAllowConnect | Returns whether the AllowConnect property has changed from its default value. |
|
|
ShouldSerializeAllowEdit | Returns whether the AllowEdit property has changed from its default value. |
|
|
ShouldSerializeAllowHide | Returns whether the AllowHide property has changed from its default value. |
|
|
ShouldSerializeAllowMinimize | Returns whether the AllowMinimize property has changed from its default value. |
|
|
ShouldSerializeAllowRemove | Returns whether the AllowRemove property has changed from its default value. |
|
|
ShouldSerializeAllowZoneChange | Returns whether the AllowZoneChange property has changed from its default value. |
|
|
ShouldSerializeConnectionID | Returns whether the ConnectionID property has changed from its default value. |
|
|
ShouldSerializeConnections | Returns whether the Connections property has changed from its default value. |
|
|
ShouldSerializeDescription | Returns whether the Description property has changed from its default value. |
|
|
ShouldSerializeDetailLink | Returns whether the DetailLink property has changed from its default value. |
|
|
ShouldSerializeDir | Returns whether the Dir property has changed from its default value. |
|
|
ShouldSerializeExportControlledProperties | Returns whether the ExportControlledProperties property has changed from its default value. |
|
|
ShouldSerializeFrameState | Returns whether the FrameState property has changed from its default value. |
|
|
ShouldSerializeFrameType | Returns whether the FrameType property has changed from its default value. |
|
|
ShouldSerializeHeight | Returns whether the Height property has changed from its default value. |
|
|
ShouldSerializeHelpLink | Returns whether the HelpLink property has changed from its default value. |
|
|
ShouldSerializeHelpMode | Returns whether the HelpMode property has changed from its default value. |
|
|
ShouldSerializeID | Returns whether the ID property has changed from its default value. |
|
|
ShouldSerializeIsIncluded | Returns whether the IsIncluded property has changed from its default value. |
|
|
ShouldSerializeIsIncludedFilter | Returns whether the IsIncludedFilter property has changed from its default value. |
|
|
ShouldSerializeIsVisible | Returns whether the IsVisible property has changed from its default value. |
|
|
ShouldSerializeMissingAssembly | Returns whether the MissingAssembly property has changed from its default value. |
|
|
ShouldSerializePartImageLarge | Returns whether the PartImageLarge property has changed from its default value. |
|
|
ShouldSerializePartImageSmall | Returns whether the PartImageSmall property has changed from its default value. |
|
|
ShouldSerializePartOrder | Returns whether the PartOrder property has changed from its default value. |
|
|
ShouldSerializeTitle | Returns whether the Title property has changed from its default value. |
|
|
ShouldSerializeWidth | Returns whether the Width property has changed from its default value. |
|
|
ShouldSerializeZoneID | Returns whether the ZoneID property has changed from its default value. |
|
|
ToString | (Inherited from Object.) |
|
|
TrackViewState | (Inherited from WebPart.) |
| Name | Description | |
|---|---|---|
|
IAttributeAccessor.GetAttribute | IAttributeAccessor.GetAttribute |
|
|
IAttributeAccessor.SetAttribute | IAttributeAccessor.SetAttribute |
|
|
IParserAccessor.AddParsedSubObject | (Inherited from Control.) |
|
|
IControlDesignerAccessor.GetDesignModeState | (Inherited from Control.) |
|
|
IConnectionData.GetData | |
|
|
IConnectionData.GetRequiresData | |
|
|
ICompositeControlDesignerAccessor.RecreateChildControls | (Inherited from Part.) |
|
|
IControlDesignerAccessor.SetDesignModeState | (Inherited from Control.) |
|
|
IControlDesignerAccessor.SetOwnerControl | (Inherited from Control.) |
