del método SPSiteExtension.DeactivateHelpCollection
Desactiva una colección de ayuda en el sitio especificado.
Espacio de nombres: Microsoft.SharePoint.Help
Ensamblado: Microsoft.SharePoint (en Microsoft.SharePoint.dll)
Sintaxis
'Declaración
<ExtensionAttribute> _
Public Shared Sub DeactivateHelpCollection ( _
site As SPSite, _
helpCollectionProduct As String _
)
'Uso
Dim site As SPSite
Dim helpCollectionProduct As String
site.DeactivateHelpCollection(helpCollectionProduct)
public static void DeactivateHelpCollection(
this SPSite site,
string helpCollectionProduct
)
Parámetros
site
Tipo: Microsoft.SharePoint.SPSiteEl sitio en el que se va a modificar la configuración de la Ayuda.
helpCollectionProduct
Tipo: System.StringEl campo Product al que se aplica la colección de ayuda; Por ejemplo, WSSEndUser.
Nota de uso
En Visual Basic y C#, se puede llamar a este método como a un método de instancia en cualquier objeto de tipo SPSite. Cuando use la sintaxis del método de instancia para llamar a este método, omita el primer parámetro. Para más información, consulte https://msdn.microsoft.com/es-es/library/bb384936(v=office.15) o https://msdn.microsoft.com/es-es/library/bb383977(v=office.15).
Excepciones
| Excepción | Condición |
|---|---|
| ArgumentNullException | helpCollectionProduct es una referencia null (Nothing en Visual Basic) o está vacía. |
Comentarios
Cada sitio mantiene una lista de colecciones de ayuda activas y esto determina el contenido de ayuda que se muestra a los visitantes del sitio. Desactivación de una colección de ayuda, quita de esta lista. Cada colección de ayuda que se almacenan en la biblioteca debe tener un valor en su campo de Product que describe el ámbito de contenido en esa colección de ayuda. Por ejemplo, la colección de ayuda para los usuarios finales Microsoft SharePoint Foundation tiene un valor de WSSEndUser para su campo Product . El parámetro helpCollectionProduct debe proporcionar el valor del campo Product de la colección de ayuda para desactivar.