PublishingCatalogUtility.GetIsFieldValueFriendlyForUrl method

Gets a Boolean value that indicates whether the SPField is valid to use to create friendly URLs for items in this catalog.

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

Syntax

'Declaration
Public Shared Function GetIsFieldValueFriendlyForUrl ( _
    catalogItemCandidateKeyField As SPField _
) As Boolean
'Usage
Dim catalogItemCandidateKeyField As SPField
Dim returnValue As Boolean

returnValue = PublishingCatalogUtility.GetIsFieldValueFriendlyForUrl(catalogItemCandidateKeyField)

public static bool GetIsFieldValueFriendlyForUrl(
    SPField catalogItemCandidateKeyField
)

Parameters

• catalogItemCandidateKeyField
  Type: Microsoft.SharePoint.SPField

  The site column being tested.

Return value

Type: System.Boolean
A Boolean value that indicates whether the SPField object is valid to use to create friendly URLs for items in this catalog.

Remarks

Use this method to determine if a field being used to uniquely identify an item is also a valid component for friendly URLs that represent the item in a subscribing site. For example, fields of type DateTime will not provide clean, friendly URLs at a subscribing site.

See also

Reference

PublishingCatalogUtility class

PublishingCatalogUtility members

Microsoft.SharePoint.Publishing namespace