This topic has not yet been rated - Rate this topic

SPSiteExtension.ActivateHelpCollection method

SharePoint 2013

SharePoint 2010

Activates a Help collection within the specified site.

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

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

Parameters

site: Type: Microsoft.SharePoint.SPSite
The site in which to modify Help settings.

helpCollectionProduct: Type: System.String
The Product field that the Help collection applies to; 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 http://msdn.microsoft.com/EN-US/library/bb384936 or http://msdn.microsoft.com/EN-US/library/bb383977.

Exceptions

Exception	Condition
ArgumentNullException	helpCollectionProduct is null or empty.

Remarks

Each site maintains a list of active Help collections and this determines the Help content available to site visitors. Activating a Help collection adds it to 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 activated.

Reference

SPSiteExtension class

SPSiteExtension members

Microsoft.SharePoint.Help namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD