Home Library Learn Samples Downloads Support Community Forums
MSDN Library
Office and SharePoint development
SharePoint general development
SharePoint 2013
Reference
.NET server API reference
Core class library
Microsoft.SharePoint.WebPartPages
WebPart class
WebPart methods
IAttributeAccessor.GetAttribute method
IAttributeAccessor.SetAttribute method
AddParsedSubObject method
AfterDeserialize method
CanRunAt method
CreateWebPartMenu method
DataBind method
Dispose method
EnsureInterfaces method
FindControl method
GetCustomBuilder method
GetData method
GetDesignTimeFooter method
GetDesignTimeHeader method
GetInitEventArgs method
GetRequiresData method
GetRouteUrl method
GetThemedImages method
GetThemedLocalizedImages method
GetToolParts method
IConnectionData.GetData method
IConnectionData.GetRequiresData method
LoadResource method
LoadViewState method
NotifyWorkItemComplete method
OnDataBinding method
OnInit method
OnPreRender method
OnUnload method
PartCacheInvalidate method
PartCacheRead method
PartCacheWrite method
PartCommunicationConnect method
PartCommunicationInit method
PartCommunicationMain method
RegisterInterface method
RegisterWorkItem method
RegisterWorkItemCallback method
Render method
RenderControl method
RenderWebPart method
RenderWorkItemTimeout method
ReplaceTokens method
RequiresWebPartClientScript method
SetWebPartPageComponent method
ShouldSerializeAllowConnect method
ShouldSerializeAllowEdit method
ShouldSerializeAllowHide method
ShouldSerializeAllowMinimize method
ShouldSerializeAllowRemove method
ShouldSerializeAllowZoneChange method
ShouldSerializeConnectionID method
ShouldSerializeConnections method
ShouldSerializeDescription method
ShouldSerializeDetailLink method
ShouldSerializeDir method
ShouldSerializeExportControlledProperties method
ShouldSerializeFrameState method
ShouldSerializeFrameType method
ShouldSerializeHeight method
ShouldSerializeHelpLink method
ShouldSerializeHelpMode method
ShouldSerializeID method
ShouldSerializeIsIncluded method
ShouldSerializeIsIncludedFilter method
ShouldSerializeIsVisible method
ShouldSerializeMissingAssembly method
ShouldSerializePartImageLarge method
ShouldSerializePartImageSmall method
ShouldSerializePartOrder method
ShouldSerializeTitle method
ShouldSerializeWidth method
ShouldSerializeZoneID method
Expand Minimize
This topic has not yet been rated - Rate this topic

WebPart.CanRunAt method

SharePoint 2013

NOTE: This API is now obsolete.

Returns a value that indicates where the implementation of a connection interface can run.

Namespace:  Microsoft.SharePoint.WebPartPages
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
C#
VB
Copy 
[ObsoleteAttribute("Use ConnectionProvider or ConnectionConsumer attribute to create ConnectionPoint instead.")]
public virtual ConnectionRunAt CanRunAt()

When developing a connectable Web Part, you must override the CanRunAt method to return the appropriate value for the implementation of a connection interface. The CanRunAt method should return a ConnectionRunAt enumeration that indicates whether implementation for the connection interface can run on the server, the client, both, or not at all (ConnectionRunAt.None). The default behavior of this method is to throw an exception that returns Strings.CommunicationMethodNotImplementedError. This method is called before the inherited System.Web.UI.Control class's PreRender event and after the Load event.

The following code example shows how to override the CanRunAt method to indicate that the connection interface can run only on the server.

To see this method in a fuller context, see Walkthrough: Creating Connectable SharePoint Web Parts

C#
VB
Copy 
public override ConnectionRunAt CanRunAt()
{
    // This Web Part can run on the server.
    return ConnectionRunAt.Server;
}
Did you find this helpful?
(1500 characters remaining)

Community Additions

ADD
© 2013 Microsoft. All rights reserved.
|
Site Feedback
© 2013 Microsoft. All rights reserved.