MetadataNavigationSettings.GetMetadataNavigationSettings Method (SPWeb, Guid)

  • Article

Gets the MetadataNavigationSettings object for a specified source list.

Namespace:  Microsoft.Office.DocumentManagement.MetadataNavigation
Assembly:  Microsoft.Office.DocumentManagement (in Microsoft.Office.DocumentManagement.dll)

Syntax

'Declaration
Public Shared Function GetMetadataNavigationSettings ( _
    web As SPWeb, _
    sourceListId As Guid _
) As MetadataNavigationSettings
'Usage
Dim web As SPWeb
Dim sourceListId As Guid
Dim returnValue As MetadataNavigationSettings

returnValue = MetadataNavigationSettings.GetMetadataNavigationSettings(web, _
    sourceListId)

public static MetadataNavigationSettings GetMetadataNavigationSettings(
    SPWeb web,
    Guid sourceListId
)

Parameters

  • sourceListId
    Type: System.Guid

    The Id of the source list for the settings.

Return Value

Type: Microsoft.Office.DocumentManagement.MetadataNavigation.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

Exception Condition
ArgumentNullException

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

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.

See Also

Reference

MetadataNavigationSettings Class

MetadataNavigationSettings Members

GetMetadataNavigationSettings Overload

Microsoft.Office.DocumentManagement.MetadataNavigation Namespace

GetMetadataNavigationSettings(SPWeb, Guid)

GetMetadataNavigationSettings(SPWeb, Guid, Boolean)

SetMetadataNavigationSettings(SPList, MetadataNavigationSettings)

SetMetadataNavigationSettings(SPList, MetadataNavigationSettings, Boolean)

SetMetadataNavigationSettings(SPList, MetadataNavigationSettings, Boolean, Boolean)