Share via


ClientApplicationWebPartBase.GetExternalApplicationRequestResult method

Gets an object that can be used to create a control that renders the Web Part.

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

Syntax

'Declaration
Protected Function GetExternalApplicationRequestResult As SPExternalApplicationRequestResult
'Usage
Dim returnValue As SPExternalApplicationRequestResult

returnValue = Me.GetExternalApplicationRequestResult()
protected SPExternalApplicationRequestResult GetExternalApplicationRequestResult()

Return value

Type: Microsoft.SharePoint.SPExternalApplicationRequestResult
An object that is used to create a control that renders the Web Part.

Exceptions

Exception Condition
InvalidOperationException

The external application has not been properly registered with either a URL or External Application XML.

SPExternalApplicationRegistrationException

The External Application XML is invalid.

Remarks

This method is typically called by the CreateChildControls() method of a class derived from ClientApplicationWebPartBase. The GetContentControl(String) method of the SPExternalApplicationRequestResult object that is returned is then called by the CreateChildControls() method to render the Web Part.

The two major steps of this method are:

The GetExternalApplicationRequestResult() method then returns the SPExternalApplicationRequestResult object that is returned to it by the OnApplicationWebPartCreateChildControls(SPExternalApplicationRequestProperties) method.

Important

The OnApplicationWebPartCreateChildControls(SPExternalApplicationRequestProperties) of the default EAP returns a null reference (Nothing in Visual Basic) and, hence, so does the GetExternalApplicationRequestResult() method when the default EAP is in use.

See also

Reference

ClientApplicationWebPartBase class

ClientApplicationWebPartBase members

Microsoft.SharePoint.WebPartPages namespace