MetadataNavigationSettings.GetMetadataNavigationSettings Method

Definition

Overloads

GetMetadataNavigationSettings(SPList)

Gets the MetadataNavigationSettings object for a specified source list.

GetMetadataNavigationSettings(SPWeb, Guid)

Gets the MetadataNavigationSettings object for a specified source list.

GetMetadataNavigationSettings(SPList)

Gets the MetadataNavigationSettings object for a specified source list.

public:
 static Microsoft::Office::DocumentManagement::MetadataNavigation::MetadataNavigationSettings ^ GetMetadataNavigationSettings(Microsoft::SharePoint::SPList ^ sourceList);
public static Microsoft.Office.DocumentManagement.MetadataNavigation.MetadataNavigationSettings GetMetadataNavigationSettings (Microsoft.SharePoint.SPList sourceList);
static member GetMetadataNavigationSettings : Microsoft.SharePoint.SPList -> Microsoft.Office.DocumentManagement.MetadataNavigation.MetadataNavigationSettings
Public Shared Function GetMetadataNavigationSettings (sourceList As SPList) As MetadataNavigationSettings

Parameters

sourceList
SPList

The source list to get the settings from

Returns

MetadataNavigationSettings

A new instance populated with the data configured for the specified sourceListId

Exceptions

The specified SPList object is set to a null reference (Nothing in Visual Basic)

Applies to

GetMetadataNavigationSettings(SPWeb, Guid)

Gets the MetadataNavigationSettings object for a specified source list.

public:
 static Microsoft::Office::DocumentManagement::MetadataNavigation::MetadataNavigationSettings ^ GetMetadataNavigationSettings(Microsoft::SharePoint::SPWeb ^ web, Guid sourceListId);
public static Microsoft.Office.DocumentManagement.MetadataNavigation.MetadataNavigationSettings GetMetadataNavigationSettings (Microsoft.SharePoint.SPWeb web, Guid sourceListId);
static member GetMetadataNavigationSettings : Microsoft.SharePoint.SPWeb * Guid -> Microsoft.Office.DocumentManagement.MetadataNavigation.MetadataNavigationSettings
Public Shared Function GetMetadataNavigationSettings (web As SPWeb, sourceListId As Guid) As MetadataNavigationSettings

Parameters

web
SPWeb

The SPWeb object that contains the source list for the settings.

sourceListId
Guid

The Id of the source list for the settings.

Returns

MetadataNavigationSettings

New instance populated with the data configured for the specified sourceListId if a matching list for the specified Id exists; otherwise, a null reference (Nothing in Visual Basic)

Exceptions

Specified SPWeb object is set to a null reference (Nothing in Visual Basic)

The MetadataNavigationSettings object is called outside of an ASP.Net page request and MetadataNavigationContext.Current is set to a null reference (Nothing in Visual Basic).

Remarks

Uses cached values if possible.

Applies to