SPSiteExtension.DeactivateHelpCollection method

  • Article

Deactivates a Help collection within the specified site.

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

Syntax

'Declaration
<ExtensionAttribute> _
Public Shared Sub DeactivateHelpCollection ( _
    site As SPSite, _
    helpCollectionProduct As String _
)
'Usage
Dim site As SPSite
Dim helpCollectionProduct As String

site.DeactivateHelpCollection(helpCollectionProduct)

public static void DeactivateHelpCollection(
    this SPSite site,
    string helpCollectionProduct
)

Parameters

  • helpCollectionProduct
    Type: System.String

    The Product field to which the Help collection applies; for example, WSSEndUser.

Usage note

In Visual Basic and C#, you can call this method as an instance method on any object of type SPSite. When you use instance method syntax to call this method, omit the first parameter. For more information, see https://msdn.microsoft.com/en-us/library/bb384936(v=office.15) or https://msdn.microsoft.com/en-us/library/bb383977(v=office.15).

Exceptions

Exception Condition
ArgumentNullException

helpCollectionProduct is a null reference (Nothing in Visual Basic) or empty.

Remarks

Each site maintains a list of active Help collections and this determines the Help content shown to site visitors. Deactivating a Help collection removes it from this list. Each Help collection stored in the Help library is required to have a value in its Product field which describes the scope of content in that collection. For example, the Microsoft SharePoint Foundation Help collection for end users has a value of WSSEndUser for its Product field. The helpCollectionProduct parameter should give the value of the Product field of the Help collection to be deactivated.

See also

Reference

SPSiteExtension class

SPSiteExtension members

Microsoft.SharePoint.Help namespace