Share via


SPLimitedWebPartManager.ImportWebPart Method

Imports an XML description file (*.dwp or *.webpart) that contains state and property data for a Web Part, and applies the data to the Web Part.

Namespace:  Microsoft.SharePoint.WebPartPages
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
<ClientCallableExceptionConstraintAttribute(FixedId := "Microsoft.SharePoint.WebPartPages.WebPartPageUserException$0",  _
    ErrorType := GetType(WebPartPageUserException), Condition := "The provided Web Part markup is not in the .dwp or .webpart format.")> _
Public Function ImportWebPart ( _
    reader As XmlReader, _
    <OutAttribute> ByRef errorMessage As String _
) As WebPart
'Usage
Dim instance As SPLimitedWebPartManager
Dim reader As XmlReader
Dim errorMessage As String
Dim returnValue As WebPart

returnValue = instance.ImportWebPart(reader, _
    errorMessage)
[ClientCallableExceptionConstraintAttribute(FixedId = "Microsoft.SharePoint.WebPartPages.WebPartPageUserException$0", 
    ErrorType = typeof(WebPartPageUserException), Condition = "The provided Web Part markup is not in the .dwp or .webpart format.")]
public WebPart ImportWebPart(
    XmlReader reader,
    out string errorMessage
)

Parameters

Return Value

Type: System.Web.UI.WebControls.WebParts.WebPart

See Also

Reference

SPLimitedWebPartManager Class

SPLimitedWebPartManager Members

Microsoft.SharePoint.WebPartPages Namespace