BaseAreaWebPart.GetAreaPath Method

NOTE: This API is now obsolete.

Obsolete. Gets the path of the area.

Namespace:  Microsoft.SharePoint.Portal.WebControls
Assembly:  Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)

Syntax

'Declaration
<ObsoleteAttribute("This control is obsolete.  Please use PortalSiteMapProvider instead")> _
Protected Function GetAreaPath As BaseAreaWebPart.AreaReturnData
'Usage
Dim returnValue As BaseAreaWebPart.AreaReturnData

returnValue = Me.GetAreaPath()
[ObsoleteAttribute("This control is obsolete.  Please use PortalSiteMapProvider instead")]
protected BaseAreaWebPart.AreaReturnData GetAreaPath()

Return Value

Type: Microsoft.SharePoint.Portal.WebControls.BaseAreaWebPart.AreaReturnData

Remarks

An example of a path to an area: Home-->Topics-->Divisions would be the result of GetAreaPath query for "Divisions" area.

See Also

Reference

BaseAreaWebPart Class

BaseAreaWebPart Members

Microsoft.SharePoint.Portal.WebControls Namespace