Export (0) Print
Expand All

WebPart.GetRequiresData method

NOTE: This API is now 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.

Namespace:  Microsoft.SharePoint.WebPartPages
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

'Declaration
<ObsoleteAttribute("Use IConnectionData.GetRequiresData() instead.")> _
Public Overridable Function GetRequiresData As Boolean
'Usage
Dim instance As WebPart
Dim returnValue As Boolean

returnValue = instance.GetRequiresData()

Return value

Type: System.Boolean
true if the Web Part requires data; otherwise, false.

The GetRequiresData method is used in conjunction with the GetData method. A connectable Web Part that requires data should override the GetRequiresData method. This method should return true until the Web Part has finished with all of its data requests. The Web Part should continue to return true even if it is not currently in a position to make a request. For example, if it is waiting on data from an interface from Microsoft.SharePoint.WebPartPages.Communication namespace such as the IFilterConsumer interface.

Community Additions

Show:
© 2014 Microsoft